Package com.digi.android.cloudconnector

Class CloudConnectorManager

java.lang.Object

com.digi.android.cloudconnector.CloudConnectorManager

public class CloudConnectorManager
extends java.lang.Object

This class provides access to the system Cloud Connector service. It allows applications to interact with the Cloud Connector service and receive events and notifications.

Unless noted, all Cloud Connector API methods require the com.digi.android.permission.CLOUD_CONNECTOR permission. If your application does not have this permission it will not have access to any Cloud Connector method.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_SIZE_OF_BINARY_DATA_POINTS_KB	Maximum size of binary data point allowed: KB.
static int	MAXIMUM_DATA_POINTS	Maximum number of data points that can be sent in just one package: .

Constructor Summary

Constructors

Constructor	Description
CloudConnectorManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
void	connect()	Opens the Cloud Connector connection.
void	disconnect()	Closes the Cloud Connector connection.
void	enableSystemMonitor(boolean enable)	Enables/disables the system monitor feature.
java.lang.String	getDeviceID()	Returns the Cloud Connector Device ID.
CloudConnectorPreferencesManager	getPreferencesManager()	Returns the Cloud Connector preferences manager.
java.lang.String	getVendorID()	Returns the device vendor ID.
boolean	isConnected()	Returns the Cloud Connector connection status.
boolean	isSystemMonitorEnabled()	Returns the current state of the system monitor.
void	registerDeviceRequestListener(java.lang.String target, IDeviceRequestListener listener)	Registers the given listener to receive Device Requests from the Cloud Connector for the given target.
void	registerEventListener(ICloudConnectorEventListener listener)	Registers the given listener to receive Cloud Connector events.
void	sendBinaryDataPoint(BinaryDataPoint dataPoint)	Sends the given BinaryDataPoint to Device Cloud.
void	sendDataPoint(DataPoint dataPoint)	Sends the given DataPoint to Device Cloud.
void	sendDataPoints(java.util.List<DataPoint> dataPoints)	Sends the given list of DataPoint to Device Cloud.
void	setVendorID(java.lang.String vendorID)	Sets the Cloud Connector Vendor ID setting.
void	unregisterDeviceRequestListener(IDeviceRequestListener listener)	Removes the given listener from the Device Request listeners list.
void	unregisterEventListener(ICloudConnectorEventListener listener)	Removes the given listener from the event listeners list.

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_DATA_POINTS

public static final int MAXIMUM_DATA_POINTS

Maximum number of data points that can be sent in just one package: .

See Also:

Constant Field Values

MAX_SIZE_OF_BINARY_DATA_POINTS_KB

public static final int MAX_SIZE_OF_BINARY_DATA_POINTS_KB

Maximum size of binary data point allowed: KB.

See Also:

Constant Field Values

Constructor Detail

CloudConnectorManager

public CloudConnectorManager(android.content.Context context)

Class constructor. Instantiates a new CloudConnectorManager using the given application context.

The CloudConnectorManager allows you to interact with the Cloud Connector service.

Parameters:

context - Android application context.

Throws:

java.lang.NullPointerException - If the context is null.

Method Detail

connect

public void connect()

Opens the Cloud Connector connection.

See Also:

disconnect(), isConnected()

disconnect

public void disconnect()

Closes the Cloud Connector connection.

See Also:

connect(), isConnected()

isConnected

public boolean isConnected()

Returns the Cloud Connector connection status.

Returns:

true if Cloud Connector is connected, false otherwise.

See Also:

connect(), disconnect()

registerEventListener

public void registerEventListener(ICloudConnectorEventListener listener)

Registers the given listener to receive Cloud Connector events.

Parameters:

listener - A ICloudConnectorEventListener that will receive Cloud Connector events.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

unregisterEventListener(ICloudConnectorEventListener), ICloudConnectorEventListener

unregisterEventListener

public void unregisterEventListener(ICloudConnectorEventListener listener)

Removes the given listener from the event listeners list.

Following this call, the listener will stop receiving Cloud Connector events.

Parameters:

listener - Listener object that no longer needs Cloud Connector events.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

registerEventListener(ICloudConnectorEventListener), ICloudConnectorEventListener

registerDeviceRequestListener

public void registerDeviceRequestListener(java.lang.String target,
                                          IDeviceRequestListener listener)

Registers the given listener to receive Device Requests from the Cloud Connector for the given target.

Parameters:

target - The Device Request target that the listener will be waiting for.

listener - A IDeviceRequestListener that will receive the Device Requests.

Throws:

java.lang.NullPointerException - If target == null or if listener == null.

See Also:

unregisterDeviceRequestListener(IDeviceRequestListener), IDeviceRequestListener

unregisterDeviceRequestListener

public void unregisterDeviceRequestListener(IDeviceRequestListener listener)

Removes the given listener from the Device Request listeners list.

Following this call, the listener will stop receiving Device Requests from the Cloud Connector service.

Parameters:

listener - Listener object that no longer needs Device Request events.

Throws:

java.lang.NullPointerException - If listener == null.

See Also:

registerDeviceRequestListener(String, IDeviceRequestListener), IDeviceRequestListener

getPreferencesManager

public CloudConnectorPreferencesManager getPreferencesManager()

Returns the Cloud Connector preferences manager.

The Cloud Connector preferences manager is used to read and set the Cloud Connector configuration parameters.

Returns:

The Cloud Connector preferences manager.

getDeviceID

public java.lang.String getDeviceID()

Returns the Cloud Connector Device ID.

Returns:

The Cloud Connector Device ID.

getVendorID

public java.lang.String getVendorID()

Returns the device vendor ID.

Vendor ID follows this format: '0x01234567'

Returns:

The device vendor ID, null if not configured.

See Also:

setVendorID(String)

setVendorID

public void setVendorID(java.lang.String vendorID)

Sets the Cloud Connector Vendor ID setting.

Vendor ID follows this format: '0x01234567'

Parameters:

vendorID - The Cloud Connector VendorID setting.

Throws:

java.lang.IllegalArgumentException - If vendorID is invalid.

java.lang.NullPointerException - If vendorID is null.

See Also:

getVendorID()

sendDataPoint

public void sendDataPoint(DataPoint dataPoint)

Sends the given DataPoint to Device Cloud.

Cloud Connector must be connected in order to send the data points, otherwise an exception is thrown.

In order to be notified about the operation result, application must be subscribed to the Cloud Connector service using a ICloudConnectorEventListener

Parameters:

dataPoint - The data point to send.

Throws:

java.lang.NullPointerException - If dataPoint == null.

java.lang.UnsupportedOperationException - If Cloud Connector is disconnected.

See Also:

registerEventListener(ICloudConnectorEventListener), sendBinaryDataPoint(BinaryDataPoint), sendDataPoints(List), unregisterEventListener(ICloudConnectorEventListener), DataPoint, ICloudConnectorEventListener

sendDataPoints

public void sendDataPoints(java.util.List<DataPoint> dataPoints)

Sends the given list of DataPoint to Device Cloud.

Cloud Connector must be connected in order to send the data points, otherwise an exception is thrown.

In order to be notified about the operation result, application must be subscribed to the Cloud Connector service using a ICloudConnectorEventListener

The size of the data points list must be between MINIMUM_DATA_POINTS and MAXIMUM_DATA_POINTS, otherwise an exception is thrown.

Parameters:

dataPoints - The data points list to send.

Throws:

java.lang.IllegalArgumentException - If dataPoints.size() < MINIMUM_DATA_POINTS or if dataPoints.size() > MAXIMUM_DATA_POINTS.

java.lang.NullPointerException - If dataPoints == null.

java.lang.UnsupportedOperationException - If Cloud Connector is disconnected.

See Also:

MAXIMUM_DATA_POINTS, MINIMUM_DATA_POINTS, registerEventListener(ICloudConnectorEventListener), sendBinaryDataPoint(BinaryDataPoint), sendDataPoint(DataPoint), unregisterEventListener(ICloudConnectorEventListener), DataPoint, ICloudConnectorEventListener

sendBinaryDataPoint

public void sendBinaryDataPoint(BinaryDataPoint dataPoint)

Sends the given BinaryDataPoint to Device Cloud.

Cloud Connector must be connected in order to send the data points, otherwise an exception is thrown.

In order to be notified about the operation result, application must be subscribed to the Cloud Connector service using a ICloudConnectorEventListener

The size of the byte array to be sent should be less than MAX_SIZE_OF_BINARY_DATA_POINTS_KB KB.

Parameters:

dataPoint - The binary data point to send.

Throws:

java.lang.NullPointerException - If dataPoint == null.

java.lang.IllegalArgumentException - If the binary value to be sent is > MAX_SIZE_OF_BINARY_DATA_POINTS_KB.

java.lang.UnsupportedOperationException - If Cloud Connector is disconnected.

See Also:

MAX_SIZE_OF_BINARY_DATA_POINTS_KB, registerEventListener(ICloudConnectorEventListener), sendDataPoint(DataPoint), sendDataPoints(List), unregisterEventListener(ICloudConnectorEventListener), BinaryDataPoint, ICloudConnectorEventListener

enableSystemMonitor

public void enableSystemMonitor(boolean enable)

Enables/disables the system monitor feature.

In order to configure the system monitor settings, you have to use the CloudConnectorPreferencesManager object. Use getPreferencesManager() method to access it.

Parameters:

enable - true to enable the system monitor, false to disable it.

See Also:

getPreferencesManager(), isSystemMonitorEnabled()

isSystemMonitorEnabled

public boolean isSystemMonitorEnabled()

Returns the current state of the system monitor.

In order to configure the system monitor settings, you have to use the CloudConnectorPreferencesManager object. Use getPreferencesManager() method to access it.

Returns:

true if the system monitor is enabled, false otherwise.

See Also:

enableSystemMonitor(boolean), getPreferencesManager()