com.etherios.connector.core

Class AbstractCloudConnector

java.lang.Object

com.etherios.connector.core.AbstractCloudConnector

Direct Known Subclasses:

AbstractPlatformConnector

public abstract class AbstractCloudConnector
extends java.lang.Object

This class provides common functionality for all Cloud Connector variants of the different platforms.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NUMBER_OF_DATA_POINTS_PER_PACKAGE Maximum number of data points that can be sent in just one package: 250.
static int	MAX_SIZE_OF_BINARY_DATA_POINTS_KB Maximum size of binary data points allowed: 64 KB.
static int	MAX_SIZE_OF_DEVICE_REQUESTS_REPLIES_KB Maximum size of replies to Device Requests: 2048 KB.
static int	MAX_SIZE_OF_SEND_DATA_REQUEST_KB Maximum size of send data requests: 2048 KB.

Constructor Summary

Constructors

Constructor and Description
AbstractCloudConnector(INetworkImplementation networkImpl, ISystemImplementation systemImpl, IConnectorPreferences connectorPreferences, ConnectorLogger connectorLogger, IRCIExtension rciExtension, IFileSystemImplementation fileSystemImpl, IFirmwareUpdateImplementation fwUpdateImpl) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	abortFirmwareUpdate(int reason) Aborts the firmware update process.
void	appendDataToRemoteFile(java.io.InputStream inputStream, java.lang.String destPath, java.lang.String contentType) Appends the data in the input stream to the given destination file in Device Cloud.
void	appendDataToRemoteFile(java.lang.String text, java.lang.String destPath) Appends a string to the given destination text file in Device Cloud.
void	deRegisterEventsListener(EventsListener eventsListener) Removes the given Cloud Connector events listener from the list of listeners.
abstract java.lang.String	getConnectorVersion() Retrieves the Cloud Connector version.
java.lang.String	getDeviceID() Retrieves the device ID associated with this connector.
IDeviceRequestListener	getDeviceRequestListener() Retrieves the Cloud Connector device request listener.
ListenerList	getEventsListenersList() Returns the list of Cloud Connector events listeners.
java.util.List<FirmwareTarget>	getFirmwareTargets() Retrieves a list of the available firmware targets.
ConnectorLogger	getLogger() Retrieves the logger used to log messages from Cloud Connector.
ConnectorNetworkManager	getNetworkManager() Retrieves the Cloud Connector network manager.
ConnectorPreferencesManager	getPreferencesManager() Retrieves the Cloud Connector preferences manager.
com.etherios.connector.core.RestrictionLevel	getRestrictionLevel() Retrieves the Cloud Connector restriction level.
long	getRXBytes() Retrieves the total bytes read by Cloud Connector.
java.lang.String	getStorageRootDir() Retrieves the directory path where file system storage root point is located.
ConnectorSystemManager	getSystemManager() Retrieves the Cloud Connector system manager.
long	getTXBytes() Retrieves the total bytes written by Cloud Connector.
byte[]	getVendorID() Retrieves the vendor ID associated with this connector.
boolean	isConnected() Retrieves whether Cloud Connector is running or not.
boolean	isStarting() Retrieves whether Cloud Connector is starting or not.
void	notifyEvent(Event event) Notifies to the events listener that an event has occurred in Cloud Connector.
void	registerDeviceRequestListener(IDeviceRequestListener deviceRequestListener) Registers the device request listener object used to be notified of incoming device requests for any target.
void	registerEventsListener(EventsListener eventsListener) Registers the events listener to be used to be notified of Cloud Connector events.
void	resetRXBytes() Resets the total bytes read by Cloud Connector.
void	resetTXBytes() Resets the total bytes written by Cloud Connector.
void	sendBinaryDataPoint(BinaryDataPoint binaryDataPoint) Sends to Device Cloud the given binary data point following the binary concise alternative format.
void	sendDataPoint(DataPoint dataPoint) Sends to Device Cloud the given data point.
void	sendDataPoint(java.util.List<DataPoint> dataPoints) Sends to Device Cloud the given list of data points.
void	sendDataToRemoteFile(java.io.InputStream inputStream, java.lang.String destPath, java.lang.String contentType) Sends the data in the input stream to the given destination file in Device Cloud.
void	sendDataToRemoteFile(java.lang.String text, java.lang.String destPath) Sends a string to the given destination text file in Device Cloud.
void	start() Starts Cloud Connector.
void	stop() Stops Cloud Connector.
void	updateDataCompressionStrategy() This method updates the compression strategy based on the device enabled compression algorithms.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NUMBER_OF_DATA_POINTS_PER_PACKAGE

public static final int MAX_NUMBER_OF_DATA_POINTS_PER_PACKAGE

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

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 points allowed: 64 KB.

See Also:

Constant Field Values

MAX_SIZE_OF_DEVICE_REQUESTS_REPLIES_KB

public static final int MAX_SIZE_OF_DEVICE_REQUESTS_REPLIES_KB

Maximum size of replies to Device Requests: 2048 KB.

See Also:

Constant Field Values

MAX_SIZE_OF_SEND_DATA_REQUEST_KB

public static final int MAX_SIZE_OF_SEND_DATA_REQUEST_KB

Maximum size of send data requests: 2048 KB.

See Also:

Constant Field Values

Constructor Detail

AbstractCloudConnector

public AbstractCloudConnector(INetworkImplementation networkImpl,
                              ISystemImplementation systemImpl,
                              IConnectorPreferences connectorPreferences,
                              ConnectorLogger connectorLogger,
                              IRCIExtension rciExtension,
                              IFileSystemImplementation fileSystemImpl,
                              IFirmwareUpdateImplementation fwUpdateImpl)

Class constructor. Instances a new Cloud Connector object using the given hooks.

Parameters:

networkImpl - Object implementing INetworkImplementation interface in charge of managing all network methods that are system/OS dependent.

systemImpl - Object implementing ISystemImplementation interface in charge of managing all system methods that are OS dependent.

connectorPreferences - Object implementing IConnectorPreferences interface in charge of managing all connector preferences that are system/OS dependent.

connectorLogger - Object extending the ConnectorLogger class in charge of logging all connector messages.

rciExtension - Object implementing IRCIExtension interface in charge of managing all RCI hooks that are user defined.

fileSystemImpl - Object implementing IFileSystemImplementation interface in charge of managing all file system service actions.

fwUpdateImpl - Object implementing the IFirmwareUpdateImplementation interface in charge of manage the system specific methods while updating the device firmware.

Method Detail

abortFirmwareUpdate

public void abortFirmwareUpdate(int reason)

Aborts the firmware update process.

Parameters:

reason - Reason of the abort.

appendDataToRemoteFile

public void appendDataToRemoteFile(java.io.InputStream inputStream,
                                   java.lang.String destPath,
                                   java.lang.String contentType)

Appends the data in the input stream to the given destination file in Device Cloud.

The input stream is closed after sending the data.

Parameters:

inputStream - Input stream containing data to be append to the given file in Device Cloud.

destPath - Path and name of the file to append the data.

contentType - File content type.

Throws:

java.lang.IllegalArgumentException - if inputStream == null

java.lang.RuntimeException - if !isConnected()

appendDataToRemoteFile

public void appendDataToRemoteFile(java.lang.String text,
                                   java.lang.String destPath)

Appends a string to the given destination text file in Device Cloud.

Parameters:

text - Text to be appended to the text file.

destPath - Path and name of the file to append the text in the Device Cloud storage.

Throws:

java.lang.IllegalArgumentException - if text == null

java.lang.RuntimeException - if !isConnected()

deRegisterEventsListener

public void deRegisterEventsListener(EventsListener eventsListener)

Removes the given Cloud Connector events listener from the list of listeners.

Parameters:

eventsListener - Listener to be removed.

getConnectorVersion

public abstract java.lang.String getConnectorVersion()

Retrieves the Cloud Connector version.

Returns:

Cloud Connector version as String.

getDeviceID

public java.lang.String getDeviceID()

Retrieves the device ID associated with this connector.

Returns:

The Device ID.

getDeviceRequestListener

public IDeviceRequestListener getDeviceRequestListener()

Retrieves the Cloud Connector device request listener.

Returns:

The Cloud Connector device request listener.

getEventsListenersList

public ListenerList getEventsListenersList()

Returns the list of Cloud Connector events listeners.

Returns:

the list of Cloud Connector events listeners.

getFirmwareTargets

public java.util.List<FirmwareTarget> getFirmwareTargets()

Retrieves a list of the available firmware targets.

The Firmware Access facility allows to update the firmware for any processors by having them registered as targets. The client can define any given segment of code as a target, and therefore update sections of code indexed by the target number assigned to it.

Returns:

List of available firmware targets to be updated.

See Also:

FirmwareTarget

getLogger

public ConnectorLogger getLogger()

Retrieves the logger used to log messages from Cloud Connector.

Returns:

The Cloud Connector logger.

getNetworkManager

public ConnectorNetworkManager getNetworkManager()

Retrieves the Cloud Connector network manager.

Returns:

The Cloud Connector network manager.

getPreferencesManager

public ConnectorPreferencesManager getPreferencesManager()

Retrieves the Cloud Connector preferences manager.

Returns:

The Cloud Connector preferences manager.

getRestrictionLevel

public com.etherios.connector.core.RestrictionLevel getRestrictionLevel()

Retrieves the Cloud Connector restriction level.

Returns:

The Cloud Connector restriction level.

getRXBytes

public long getRXBytes()

Retrieves the total bytes read by Cloud Connector.

Returns:

The total bytes read by Cloud Connector.

getStorageRootDir

public java.lang.String getStorageRootDir()

Retrieves the directory path where file system storage root point is located.

Used mainly by the File System service. It may be null if the file system is not enabled in the Cloud Connector configuration.

Returns:

File system storage root directory.

getSystemManager

public ConnectorSystemManager getSystemManager()

Retrieves the Cloud Connector system manager.

Returns:

The Cloud Connector system manager.

getTXBytes

public long getTXBytes()

Retrieves the total bytes written by Cloud Connector.

Returns:

The total bytes written by Cloud Connector.

getVendorID

public byte[] getVendorID()

Retrieves the vendor ID associated with this connector.

Returns:

The Vendor ID.

isConnected

public boolean isConnected()

Retrieves whether Cloud Connector is running or not.

Returns:

True if Cloud Connector is running, false otherwise.

isStarting

public boolean isStarting()

Retrieves whether Cloud Connector is starting or not.

Returns:

True if Cloud Connector is starting, false otherwise.

notifyEvent

public void notifyEvent(Event event)

Notifies to the events listener that an event has occurred in Cloud Connector.

Parameters:

event - Event to to notify.

registerDeviceRequestListener

public void registerDeviceRequestListener(IDeviceRequestListener deviceRequestListener)

Registers the device request listener object used to be notified of incoming device requests for any target.

Parameters:

deviceRequestListener - Device request listener object used to be notified of incoming device requests for any target.

registerEventsListener

public void registerEventsListener(EventsListener eventsListener)

Registers the events listener to be used to be notified of Cloud Connector events.

This method has no effect if the same listener is already registered.

Parameters:

eventsListener - Events listener object to be notified of Cloud Connector events.

resetRXBytes

public void resetRXBytes()

Resets the total bytes read by Cloud Connector.

resetTXBytes

public void resetTXBytes()

Resets the total bytes written by Cloud Connector.

sendBinaryDataPoint

public void sendBinaryDataPoint(BinaryDataPoint binaryDataPoint)

Sends to Device Cloud the given binary data point following the binary concise alternative format.

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

The associated DataStream attributes obtained with getUnits() and getForwardTo() will not be used in the binary concise alternative format, although they are specified.

Parameters:

binaryDataPoint - The binary data point to be sent.

Throws:

java.lang.IllegalArgumentException - if binaryDataPoint == null or if the binary value to be sent is > MAX_SIZE_OF_BINARY_DATA_POINTS_KB

sendDataPoint

public void sendDataPoint(DataPoint dataPoint)

Sends to Device Cloud the given data point.

Parameters:

dataPoint - The data point to be sent.

Throws:

java.lang.IllegalArgumentException - if dataPoint == null.

sendDataPoint

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

Sends to Device Cloud the given list of data points.

Parameters:

dataPoints - The list of data points to be sent.

Throws:

java.lang.IllegalArgumentException - if dataPoints == null or if dataPoints.isEmpty() or if dataPoints.size() > MAX_NUMBER_OF_DATA_POINTS_PER_PACKAGE

java.lang.RuntimeException - if !isConnected()

See Also:

MAX_NUMBER_OF_DATA_POINTS_PER_PACKAGE

sendDataToRemoteFile

public void sendDataToRemoteFile(java.io.InputStream inputStream,
                                 java.lang.String destPath,
                                 java.lang.String contentType)

Sends the data in the input stream to the given destination file in Device Cloud.

If the destination file already exists it will be overwrote.

The input stream is closed after sending the data.

Parameters:

inputStream - Input stream containing data to be stored in Device Cloud.

destPath - Path and name of the file to store the data in Device Cloud.

contentType - File content type.

Throws:

java.lang.IllegalArgumentException - if inputStream == null

java.lang.RuntimeException - if !isConnected()

sendDataToRemoteFile

public void sendDataToRemoteFile(java.lang.String text,
                                 java.lang.String destPath)

Sends a string to the given destination text file in Device Cloud.

If the destination file already exists it will be overwrote.

Parameters:

text - Text to be written in the text file.

destPath - Path and name of the file to be stored in the Device Cloud storage.

Throws:

java.lang.IllegalArgumentException - if text == null

java.lang.RuntimeException - if !isConnected()

start

public void start()

Starts Cloud Connector.

stop

public void stop()

Stops Cloud Connector.

updateDataCompressionStrategy

public void updateDataCompressionStrategy()

This method updates the compression strategy based on the device enabled compression algorithms. This method is usually called if the compression capabilities change in the device.