com.etherios.connector.core.events

Interface EventsListener

public interface EventsListener

Cloud Connector generates several events while it is running. Sometimes, devices integrating Cloud Connector may want to be notified when these events occur, process them and execute an specific action. For this reason, this interface defines the required methods that should be implemented in order to be notified about Cloud Connector events:

• Connection events: notifyConnectionEvent(ConnectionEvent).
• Data push events: notifyDataPushEvent(DataPushEvent).
• Data points events: notifyDataPointEvent(DataPointEvent).
• File system events: notifyFileSystemEvent(FileSystemEvent).
• RCI events: notifyRCIEvent(RCIEvent).
• Firmware update events: notifyFirmwareEvent(FirmwareEvent).

To register this event use the method registerEventsListener(EventsListener) of the Cloud Connector object. Several events listeners can be registered.

To deregister this event use the method deRegisterEventsListener(EventsListener) of the Cloud Connector object.

See Also:

AbstractCloudConnector.registerEventsListener(EventsListener), AbstractCloudConnector.deRegisterEventsListener(EventsListener)

Method Summary

Modifier and Type	Method and Description
void	notifyConnectionEvent(ConnectionEvent event) Notifies that a connection event occurred.
void	notifyDataPointEvent(DataPointEvent event) Notifies that a data point event occurred.
void	notifyDataPushEvent(DataPushEvent event) Notifies that a data push event occurred.
void	notifyFileSystemEvent(FileSystemEvent event) Notifies that a file system event occurred.
void	notifyFirmwareEvent(FirmwareEvent event) Notifies that a firmware event occurred.
void	notifyRCIEvent(RCIEvent event) Notifies that an RCI event occurred.

Method Detail

notifyConnectionEvent

void notifyConnectionEvent(ConnectionEvent event)

Notifies that a connection event occurred. This event is triggered in one of these situations and event can be casted to its corresponding class:

• Connect sequence is started: ConnectionEvent.StartingConnectionEvent.
• Connection is established: ConnectionEvent.ConnectedEvent.
• Connection is closed: ConnectionEvent.DisconnectedEvent.
• Connection error: ConnectionEvent.ConnectionErrorEvent.

You can obtain the event type with the getConnectionEventType() method.

Parameters:

event - Connection event.

See Also:

ConnectionEvent, ConnectionEvent.getConnectionEventType(), ConnectionEvent.StartingConnectionEvent, ConnectionEvent.ConnectedEvent, ConnectionEvent.DisconnectedEvent, ConnectionEvent.ConnectionErrorEvent

notifyDataPointEvent

void notifyDataPointEvent(DataPointEvent event)

Notifies that a data point event occurred. This event is fired when the status of the data point transaction is received from the server. You can obtain the status with the getStatus() method.

Parameters:

event - Data point event.

See Also:

DataPointEvent, DataPointEvent.getStatus()

notifyDataPushEvent

void notifyDataPushEvent(DataPushEvent event)

Notifies that a data push event occurred. Normally this event is fired when the status is received from the server (DataPushEvent) You can obtain the status with the getStatus() method.

Parameters:

event - Data push event.

See Also:

DataPushEvent, DataPushEvent.getStatus()

notifyFileSystemEvent

void notifyFileSystemEvent(FileSystemEvent event)

Notifies that a file system event occurred. Normally this event is fired after a request in the file system service of any kind and event can be casted to its corresponding class:

• File list request: FileSystemEvent.FileListEvent.
• File upload request: FileSystemEvent.FileUploadEvent.
• File download request: FileSystemEvent.FileDownloadEvent.
• File removal request: FileSystemEvent.FileRemoveEvent.
• File system error: FileSystemEvent.FileSystemErrorEvent.

You can obtain the event type with the getFileSystemEventType() method.

Parameters:

event - File system event.

See Also:

FileSystemEvent, FileSystemEvent.getFileSystemEventType(), FileSystemEvent.FileListEvent, FileSystemEvent.FileUploadEvent, FileSystemEvent.FileDownloadEvent, FileSystemEvent.FileRemoveEvent, FileSystemEvent.FileSystemErrorEvent

notifyFirmwareEvent

void notifyFirmwareEvent(FirmwareEvent event)

Notifies that a firmware event occurred. The event is fired every time a firmware related request is received and can be casted to its corresponding class:

• Firmware information request: FirmwareEvent.FirmwareTargetInfoEvent.
• Firmware download request: FirmwareEvent.FirmwareUpdateRequestEvent.
• Firmware data block received: FirmwareEvent.FirmwareBinaryBlockEvent.
• Firmware download finished: FirmwareEvent.FirmwareCompleteEvent.
• Firmware download abort: FirmwareEvent.FirmwareUpdateAbortEvent.
• Firmware reset request: FirmwareEvent.FirmwareTargetResetEvent.
• Firmware update error: FirmwareEvent.FirmwareErrorEvent.

The event contains the corresponding firmware event type, use the method getFirmwareEventType().

Parameters:

event - Firmware event.

See Also:

FirmwareEvent, FirmwareEvent.getFirmwareEventType(), FirmwareEvent.FirmwareTargetInfoEvent, FirmwareEvent.FirmwareUpdateRequestEvent, FirmwareEvent.FirmwareBinaryBlockEvent, FirmwareEvent.FirmwareCompleteEvent, FirmwareEvent.FirmwareUpdateAbortEvent, FirmwareEvent.FirmwareTargetResetEvent, t

notifyRCIEvent

void notifyRCIEvent(RCIEvent event)

Notifies that an RCI event occurred. Normally this event is fired in the RCI facility in one of these scenarios:

• Query device descriptor request.
• Query state request.
• Query setting request.
• Set setting request.
• Set state request.
• Reboot request.
• Set factory defaults request.
• Do command request.

The event contains the corresponding RCI event type.

Parameters:

event - RCI event.

See Also:

RCIEvent