com.TersoSolutions.Jetstream.SDK.Application.User

Class JetstreamServiceClient

java.lang.Object

com.TersoSolutions.Jetstream.SDK.Application.JetstreamClient

com.TersoSolutions.Jetstream.SDK.Application.User.JetstreamServiceClient

public class JetstreamServiceClient
extends JetstreamClient

Client proxy object for the Jetstream Web Service

Since:

1.0

Author:

Johnathon Ender

Constructor Summary

Constructors

Constructor and Description
JetstreamServiceClient() Constructor for the JetstreamServiceClient.
JetstreamServiceClient(java.io.File properties) Constructor for the JetstreamServiceClient.
JetstreamServiceClient(java.lang.String jetstreamAPIUrl, java.lang.String accessKey) Constructor for the JetstreamServiceClient.

Method Summary

Methods

Modifier and Type	Method and Description
AddDeviceToPolicyResponse	AddDeviceToPolicy(AddDeviceToPolicyRequest request) Calls the Jetstream v1.1 AddDeviceToPolicy REST endpoint and adds a device to one of your application's policies.
AddLogicalDeviceResponse	AddLogicalDevice(AddLogicalDeviceRequest request) Calls the Jetstream v1.0 AddLogicalDevice REST endpoint and adds a device to your application.
AddPolicyResponse	AddPolicy(AddPolicyRequest request) Calls the Jetstream v1.1 AddPolicy REST endpoint and adds a new policy to your application.
DeviceSpecificCommandResponse	DeviceSpecificCommand(DeviceSpecificCommandRequest request) Calls the Jetstream v1.0 DeviceSpecificCommand REST endpoint to queue a command specific to an individual device type https://jetstreamrfid.com/Docs/Application/1.0/DeviceSpecificCommand.aspx
java.lang.String	getAccessKey() Returns the root https url for the Jetstream web service.
java.lang.String	getBaseUri() Returns the root https url for the Jetstream web service.
GetConfigurationResponse	GetConfiguration(GetConfigurationRequest request) Calls the Jetstream v1.1 GetConfiguration REST endpoint https://jetstreamrfid.com/Docs/Application/1.1/GetConfiguration.aspx
GetConfigValuesCommandResponse	GetConfigValuesCommand(GetConfigValuesCommandRequest request) Calls the Jetstream v1.0 GetConfigValuesCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/GetConfigValuesCommand .aspx
GetDeviceDefinitionsResponse	GetDeviceDefinitions(GetDeviceDefinitionsRequest request) Calls the Jetstream v1.0 GetDeviceDefinitions REST endpoint https://jetstreamrfid.com/Docs/Application/1.0/GetDeviceDefinitions.aspx
GetEPCListCommandResponse	GetEPCListCommand(GetEPCListCommandRequest request) Calls the Jetstream v1.0 GetEPCListCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/GetEPCListCommand.aspx
GetEventsResponse	GetEvents(GetEventsRequest request) Calls the Jetstream v1.2 GetEvents REST endpoint https://jetstreamrfid.com/Docs/Application/1.2/GetEvents.aspx
GetPoliciesResponse	GetPolicies(GetPoliciesRequest request) Calls the Jetstream v1.1 GetPolicies REST endpoint and adds a new policy to your application.
RemoveDeviceFromPolicyResponse	RemoveDeviceFromPolicy(RemoveDeviceFromPolicyRequest request) Calls the Jetstream v1.1 RemoveDeviceFromPolicy REST endpoint and removes an existing device from a policy https://jetstreamrfid.com/Docs/Application /1.1/RemoveDeviceFromPolicy.aspx
RemoveEventsResponse	RemoveEvents(RemoveEventsRequest request) Calls the Jetstream v1.2 RemoveEvents REST endpoint https://jetstreamrfid.com/Docs/Application/1.2/RemoveEvents.aspx
RemoveLogicalDeviceResponse	RemoveLogicalDevice(RemoveLogicalDeviceRequest request) Calls the Jetstream v1.0 RemoveLogicalDevice REST endpoint and removes a device from your application.
RemovePolicyResponse	RemovePolicy(RemovePolicyRequest request) Calls the Jetstream v1.1 RemovePolicy REST endpoint and removes an existing policy from your application.
ResetCommandResponse	ResetCommand(ResetCommandRequest request) Calls the Jetstream v1.0 ResetCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/ResetCommand.aspx
SetConfigValuesCommandResponse	SetConfigValuesCommand(SetConfigValuesCommandRequest request) Calls the Jetstream v1.0 SetConfigValuesCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/SetConfigValuesCommand .aspx
UpdateFirmwareCommandResponse	UpdateFirmwareCommand(UpdateFirmwareCommandRequest request) Calls the Jetstream v1.0 UpdateFirmwareCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/UpdateFirmwareCommand.aspx

Methods inherited from class com.TersoSolutions.Jetstream.SDK.Application.JetstreamClient

execute, SendToJetstream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JetstreamServiceClient

public JetstreamServiceClient()

Constructor for the JetstreamServiceClient. This client is the base service for accessing the Jetstream REST endpoints. Reads information from the service.properties file located at the root of the project

Throws:

java.lang.IllegalArgumentException

JetstreamServiceClient

public JetstreamServiceClient(java.io.File properties)

Constructor for the JetstreamServiceClient. This client is the base service for accessing the Jetstream REST endpoints. Reads information from the provided file

Parameters:

properties - The properties file

Throws:

java.lang.IllegalArgumentException

JetstreamServiceClient

public JetstreamServiceClient(java.lang.String jetstreamAPIUrl,
                      java.lang.String accessKey)

Constructor for the JetstreamServiceClient. This client is the base service for accessing the Jetstream REST endpoints.

Parameters:

jetstreamAPIUrl - The root https url for the Jetstream web service.

https://jetstream.tersosolutions.com

https://jetstreambeta.tersosolutions.com

accessKey - Your accesskey for Jetstream

Throws:

java.lang.IllegalArgumentException

Method Detail

getBaseUri

public java.lang.String getBaseUri()

Returns the root https url for the Jetstream web service.

Returns:

a String representing the root https url for the Jetstream web service.

getAccessKey

public java.lang.String getAccessKey()

Returns the root https url for the Jetstream web service.

Returns:

a String representing the root https url for the Jetstream web service.

AddLogicalDevice

public AddLogicalDeviceResponse AddLogicalDevice(AddLogicalDeviceRequest request)
                                          throws JetstreamResponseException,
                                                 java.lang.IllegalArgumentException

Calls the Jetstream v1.0 AddLogicalDevice REST endpoint and adds a device to your application. https://jetstreamrfid.com/Docs/Application/1.0/AddLogicalDevice.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetDeviceDefinitions

public GetDeviceDefinitionsResponse GetDeviceDefinitions(GetDeviceDefinitionsRequest request)
                                                  throws JetstreamResponseException,
                                                         java.lang.IllegalArgumentException

Calls the Jetstream v1.0 GetDeviceDefinitions REST endpoint https://jetstreamrfid.com/Docs/Application/1.0/GetDeviceDefinitions.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

RemoveLogicalDevice

public RemoveLogicalDeviceResponse RemoveLogicalDevice(RemoveLogicalDeviceRequest request)
                                                throws JetstreamResponseException,
                                                       java.lang.IllegalArgumentException

Calls the Jetstream v1.0 RemoveLogicalDevice REST endpoint and removes a device from your application. https://jetstreamrfid.com/Docs/Application/1.0/RemoveLogicalDevice.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetEPCListCommand

public GetEPCListCommandResponse GetEPCListCommand(GetEPCListCommandRequest request)
                                            throws JetstreamResponseException,
                                                   java.lang.IllegalArgumentException

Calls the Jetstream v1.0 GetEPCListCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/GetEPCListCommand.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

DeviceSpecificCommand

public DeviceSpecificCommandResponse DeviceSpecificCommand(DeviceSpecificCommandRequest request)
                                                    throws JetstreamResponseException,
                                                           java.lang.IllegalArgumentException

Calls the Jetstream v1.0 DeviceSpecificCommand REST endpoint to queue a command specific to an individual device type https://jetstreamrfid.com/Docs/Application/1.0/DeviceSpecificCommand.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

ResetCommand

public ResetCommandResponse ResetCommand(ResetCommandRequest request)
                                  throws JetstreamResponseException,
                                         java.lang.IllegalArgumentException

Calls the Jetstream v1.0 ResetCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/ResetCommand.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetConfigValuesCommand

public GetConfigValuesCommandResponse GetConfigValuesCommand(GetConfigValuesCommandRequest request)
                                                      throws JetstreamResponseException,
                                                             java.lang.IllegalArgumentException

Calls the Jetstream v1.0 GetConfigValuesCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/GetConfigValuesCommand .aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

SetConfigValuesCommand

public SetConfigValuesCommandResponse SetConfigValuesCommand(SetConfigValuesCommandRequest request)
                                                      throws JetstreamResponseException,
                                                             java.lang.IllegalArgumentException

Calls the Jetstream v1.0 SetConfigValuesCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/SetConfigValuesCommand .aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

UpdateFirmwareCommand

public UpdateFirmwareCommandResponse UpdateFirmwareCommand(UpdateFirmwareCommandRequest request)
                                                    throws JetstreamResponseException,
                                                           java.lang.IllegalArgumentException

Calls the Jetstream v1.0 UpdateFirmwareCommand REST endpoint to queue a command https://jetstreamrfid.com/Docs/Application/1.0/UpdateFirmwareCommand.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetConfiguration

public GetConfigurationResponse GetConfiguration(GetConfigurationRequest request)
                                          throws JetstreamResponseException,
                                                 java.lang.IllegalArgumentException

Calls the Jetstream v1.1 GetConfiguration REST endpoint https://jetstreamrfid.com/Docs/Application/1.1/GetConfiguration.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

AddDeviceToPolicy

public AddDeviceToPolicyResponse AddDeviceToPolicy(AddDeviceToPolicyRequest request)
                                            throws JetstreamResponseException,
                                                   java.lang.IllegalArgumentException

Calls the Jetstream v1.1 AddDeviceToPolicy REST endpoint and adds a device to one of your application's policies. https://jetstreamrfid.com/Docs/Application/1.1/AddDeviceToPolicy.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

AddPolicy

public AddPolicyResponse AddPolicy(AddPolicyRequest request)
                            throws JetstreamResponseException,
                                   java.lang.IllegalArgumentException

Calls the Jetstream v1.1 AddPolicy REST endpoint and adds a new policy to your application. https://jetstreamrfid.com/Docs/Application/1.1/AddPolicy.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetPolicies

public GetPoliciesResponse GetPolicies(GetPoliciesRequest request)
                                throws JetstreamResponseException

Calls the Jetstream v1.1 GetPolicies REST endpoint and adds a new policy to your application. https://jetstreamrfid.com/Docs/Application/1.1/GetPolicies.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

RemovePolicy

public RemovePolicyResponse RemovePolicy(RemovePolicyRequest request)
                                  throws JetstreamResponseException,
                                         java.lang.IllegalArgumentException

Calls the Jetstream v1.1 RemovePolicy REST endpoint and removes an existing policy from your application. https://jetstreamrfid.com/Docs/Application/1.1/RemovePolicy.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

RemoveDeviceFromPolicy

public RemoveDeviceFromPolicyResponse RemoveDeviceFromPolicy(RemoveDeviceFromPolicyRequest request)
                                                      throws JetstreamResponseException

Calls the Jetstream v1.1 RemoveDeviceFromPolicy REST endpoint and removes an existing device from a policy https://jetstreamrfid.com/Docs/Application /1.1/RemoveDeviceFromPolicy.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

GetEvents

public GetEventsResponse GetEvents(GetEventsRequest request)
                            throws JetstreamResponseException,
                                   java.lang.IllegalArgumentException

Calls the Jetstream v1.2 GetEvents REST endpoint https://jetstreamrfid.com/Docs/Application/1.2/GetEvents.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException

RemoveEvents

public RemoveEventsResponse RemoveEvents(RemoveEventsRequest request)
                                  throws JetstreamResponseException,
                                         java.lang.IllegalArgumentException

Calls the Jetstream v1.2 RemoveEvents REST endpoint https://jetstreamrfid.com/Docs/Application/1.2/RemoveEvents.aspx

Parameters:

request - Object that represents the HTTP Jetstream request

Returns:

Object that represents the HTTP Jetstream response

Throws:

JetstreamResponseException

java.lang.IllegalArgumentException