com.ibm.wiotp.sdk.app

Class ApplicationClient

java.lang.Object

com.ibm.wiotp.sdk.AbstractClient

com.ibm.wiotp.sdk.app.ApplicationClient

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.MqttCallback, org.eclipse.paho.client.mqttv3.MqttCallbackExtended

public class ApplicationClient
extends AbstractClient
implements org.eclipse.paho.client.mqttv3.MqttCallbackExtended

A client, used by application, that handles connections with the IBM Watson IoT Platform.
This is a derived class from AbstractClient and can be used by end-applications to handle connections with IBM Watson IoT Platform.

Field Summary

Fields inherited from class com.ibm.wiotp.sdk.AbstractClient

CLIENT_ID_DELIMITER, config, DEFAULT_ACTION_TIMEOUT, DEFAULT_DISCONNECTED_BUFFER_SIZE, DEFAULT_MAX_CONNECT_ATTEMPTS, DEFAULT_MAX_INFLIGHT_MESSAGES, DEFAULT_MESSAGING_QOS, disconnectRequested, gson, messageCount, mqttAsyncClient, mqttCallback, mqttClient, mqttClientOptions, persistence

Constructor Summary

Constructors

Constructor and Description
ApplicationClient()
ApplicationClient(ApplicationConfig config) Create an application client for the IBM Watson IoT Platform.

Method Summary

Modifier and Type	Method and Description
void	connectComplete(boolean reconnect, String serverURI)
void	connectionLost(Throwable e) Simply log error when connection is lost
void	deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token) A completed deliver does not guarantee that the message is recieved by the service because devices send messages with Quality of Service (QoS) 0.
void	messageArrived(String topic, org.eclipse.paho.client.mqttv3.MqttMessage msg)
boolean	publishCommand(String typeId, String deviceId, String commandId, Object data)
boolean	publishCommand(String typeId, String deviceId, String commandId, Object data, int qos) Publish command to the IBM Watson IoT Platform.
boolean	publishEvent(String typeId, String deviceId, String eventId, Object data)
boolean	publishEvent(String typeId, String deviceId, String eventId, Object data, int qos) Publish event, on the behalf of a device, to the IBM Watson IoT Platform.
void	registerCodec(MessageCodec codec)
void	registerCommandCallback(CommandCallback callback)
void	registerEventCallback(EventCallback callback)
void	setStatusCallback(StatusCallback callback)
void	subscribeToApplicationStatus(String appId) Subscribe to application status of the IBM Watson IoT Platform.
void	subscribeToDeviceCommands(String typeId)
void	subscribeToDeviceCommands(String typeId, String deviceId)
void	subscribeToDeviceCommands(String typeId, String deviceId, String commandId)
void	subscribeToDeviceCommands(String typeId, String deviceId, String commandId, String format)
void	subscribeToDeviceCommands(String typeId, String deviceId, String commandId, String format, int qos) Subscribe to device commands, on the behalf of a device, of the IBM Watson IoT Platform.
void	subscribeToDeviceEvents()
void	subscribeToDeviceEvents(String typeId)
void	subscribeToDeviceEvents(String typeId, String deviceId)
void	subscribeToDeviceEvents(String typeId, String deviceId, String eventId)
void	subscribeToDeviceEvents(String typeId, String deviceId, String eventId, String format)
void	subscribeToDeviceEvents(String typeId, String deviceId, String eventId, String format, int qos) Subscribe to device events of the IBM Watson IoT Platform.
void	subscribeToDeviceStatus(String typeId, String deviceId) Subscribe to device status of the IBM Watson IoT Platform.
void	unSubscribeFromApplicationStatus(String appId) Unsubscribe from application status of the IBM Watson IoT Platform.
void	unsubscribeFromDeviceCommands()
void	unsubscribeFromDeviceCommands(String typeId)
void	unsubscribeFromDeviceCommands(String typeId, String commandId)
void	unsubscribeFromDeviceCommands(String typeId, String deviceId, String commandId) Unsubscribe from device commands of the IBM Watson IoT Platform.
void	unsubscribeFromDeviceEvents()
void	unsubscribeFromDeviceEvents(String typeId)
void	unsubscribeFromDeviceEvents(String typeId, String deviceId)
void	unsubscribeFromDeviceEvents(String typeId, String deviceId, String eventId) Unsubscribe from device events of the IBM Watson IoT Platform.

Methods inherited from class com.ibm.wiotp.sdk.AbstractClient

close, configureMqttClient, connect, disconnect, getConfig, isConnected, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationClient

public ApplicationClient()
                  throws Exception

Throws:

Exception

ApplicationClient

public ApplicationClient(ApplicationConfig config)
                  throws Exception

Create an application client for the IBM Watson IoT Platform. Connecting to specific org on IBM Watson IoT Platform

Parameters:

config - Configuration object for the client

Throws:

Exception - Failure in parsing the properties

Method Detail

publishEvent

public boolean publishEvent(String typeId,
                            String deviceId,
                            String eventId,
                            Object data,
                            int qos)

Publish event, on the behalf of a device, to the IBM Watson IoT Platform.
This method will attempt to create a JSON obejct out of the payload

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

eventId - object of String which denotes event

data - Payload data

qos - Quality of Service, in int - can have values 0,1,2

Returns:

Whether the send was successful.

publishEvent

public boolean publishEvent(String typeId,
                            String deviceId,
                            String eventId,
                            Object data)

publishCommand

public boolean publishCommand(String typeId,
                              String deviceId,
                              String commandId,
                              Object data,
                              int qos)

Publish command to the IBM Watson IoT Platform.
This method will attempt to create a JSON obejct out of the payload

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

commandId - object of String which denotes command

data - Payload data

qos - Quality of Service, in int - can have values 0,1,2

Returns:

Whether the send was successful.

publishCommand

public boolean publishCommand(String typeId,
                              String deviceId,
                              String commandId,
                              Object data)

subscribeToDeviceEvents

public void subscribeToDeviceEvents(String typeId,
                                    String deviceId,
                                    String eventId,
                                    String format,
                                    int qos)

Subscribe to device events of the IBM Watson IoT Platform.

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

eventId - object of String which denotes event

format - object of String which denotes format

qos - Quality of Service, in int - can have values 0,1,2

subscribeToDeviceEvents

public void subscribeToDeviceEvents(String typeId,
                                    String deviceId,
                                    String eventId,
                                    String format)

subscribeToDeviceEvents

public void subscribeToDeviceEvents(String typeId,
                                    String deviceId,
                                    String eventId)

subscribeToDeviceEvents

public void subscribeToDeviceEvents(String typeId,
                                    String deviceId)

subscribeToDeviceEvents

public void subscribeToDeviceEvents(String typeId)

subscribeToDeviceEvents

public void subscribeToDeviceEvents()

unsubscribeFromDeviceEvents

public void unsubscribeFromDeviceEvents(String typeId,
                                        String deviceId,
                                        String eventId)

Unsubscribe from device events of the IBM Watson IoT Platform.

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

eventId - object of String which denotes event

unsubscribeFromDeviceEvents

public void unsubscribeFromDeviceEvents(String typeId,
                                        String deviceId)

unsubscribeFromDeviceEvents

public void unsubscribeFromDeviceEvents(String typeId)

unsubscribeFromDeviceEvents

public void unsubscribeFromDeviceEvents()

subscribeToDeviceCommands

public void subscribeToDeviceCommands(String typeId,
                                      String deviceId,
                                      String commandId,
                                      String format,
                                      int qos)

Subscribe to device commands, on the behalf of a device, of the IBM Watson IoT Platform.

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

commandId - object of String which denotes command

format - object of String which denotes format

qos - Quality of Service, in int - can have values 0,1,2

subscribeToDeviceCommands

public void subscribeToDeviceCommands(String typeId,
                                      String deviceId,
                                      String commandId,
                                      String format)

subscribeToDeviceCommands

public void subscribeToDeviceCommands(String typeId,
                                      String deviceId,
                                      String commandId)

subscribeToDeviceCommands

public void subscribeToDeviceCommands(String typeId,
                                      String deviceId)

subscribeToDeviceCommands

public void subscribeToDeviceCommands(String typeId)

unsubscribeFromDeviceCommands

public void unsubscribeFromDeviceCommands(String typeId,
                                          String deviceId,
                                          String commandId)

Unsubscribe from device commands of the IBM Watson IoT Platform.

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

commandId - object of String which denotes command

unsubscribeFromDeviceCommands

public void unsubscribeFromDeviceCommands(String typeId,
                                          String commandId)

unsubscribeFromDeviceCommands

public void unsubscribeFromDeviceCommands(String typeId)

unsubscribeFromDeviceCommands

public void unsubscribeFromDeviceCommands()

subscribeToDeviceStatus

public void subscribeToDeviceStatus(String typeId,
                                    String deviceId)

Subscribe to device status of the IBM Watson IoT Platform.

Parameters:

typeId - object of String which denotes deviceType

deviceId - object of String which denotes deviceId

subscribeToApplicationStatus

public void subscribeToApplicationStatus(String appId)

Subscribe to application status of the IBM Watson IoT Platform.

Parameters:

appId - object of String which denotes the application uniquely in the organization

unSubscribeFromApplicationStatus

public void unSubscribeFromApplicationStatus(String appId)

Unsubscribe from application status of the IBM Watson IoT Platform.

Parameters:

appId - object of String which denotes the application uniquely in the organization

connectionLost

public void connectionLost(Throwable e)

Simply log error when connection is lost

Specified by:

connectionLost in interface org.eclipse.paho.client.mqttv3.MqttCallback

connectComplete

public void connectComplete(boolean reconnect,
                            String serverURI)

Specified by:

connectComplete in interface org.eclipse.paho.client.mqttv3.MqttCallbackExtended

deliveryComplete

public void deliveryComplete(org.eclipse.paho.client.mqttv3.IMqttDeliveryToken token)

A completed deliver does not guarantee that the message is recieved by the service because devices send messages with Quality of Service (QoS) 0. The message count represents the number of messages that were sent by the device without an error on from the perspective of the device.

Specified by:

deliveryComplete in interface org.eclipse.paho.client.mqttv3.MqttCallback

messageArrived

public void messageArrived(String topic,
                           org.eclipse.paho.client.mqttv3.MqttMessage msg)

Specified by:

messageArrived in interface org.eclipse.paho.client.mqttv3.MqttCallback

registerCodec

public void registerCodec(MessageCodec codec)

registerCommandCallback

public void registerCommandCallback(CommandCallback callback)

registerEventCallback

public void registerEventCallback(EventCallback callback)

setStatusCallback

public void setStatusCallback(StatusCallback callback)