com.TersoSolutions.Jetstream.SDK.Application.Events

Class JetstreamEventService

java.lang.Object

com.TersoSolutions.Jetstream.SDK.Application.Events.JetstreamEventService

public abstract class JetstreamEventService
extends java.lang.Object

An abstract class that implements a recurring service to receive and remove JetstreamEvents from the event queue.

Since:

1.2

Author:

Johnathon Ender

Constructor Summary

Constructors

Constructor and Description
JetstreamEventService() Uses the information in the service.properties file located at the root directory of the implementing project to create a new instance of the JetstreamEventService.
JetstreamEventService(java.io.File properties) Uses the information in the file passed to the constructor to create a new instance of the JetstreamEventService.
JetstreamEventService(java.lang.String baseURI, java.lang.String accessKey, long windowTime) Uses the information passed to the constructor to create a new instance of the JetstreamEventServcie

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessKey() Returns the access key being used by the service
java.lang.String	getBaseUri() Returns the base uri currently being used by the servcie to communicate with Jetstream
long	getWindowTime() Returns the amount of time in milliseconds between event polling
protected abstract void	processAggregateEvent(AggregateEvent aggregateEvent) Abstract method for processing a new Aggregate Event
protected abstract void	processCommandCompletionEvent(CommandCompletionEvent commandCompletionEvent) Abstract method for processing a new Command Completion Event
protected abstract void	processCommandQueuedEvent(CommandQueuedEvent commandQueuedEvent) Abstract method for processing a new Command Queued Event
protected abstract void	processDeviceFailureEvent(DeviceFailureEvent deviceFailureEvent) Abstract method for processing a new Device Failure Event
protected abstract void	processDeviceRestoreEvent(DeviceRestoreEvent deviceRestoreEvent) Abstract method for processing a new Device Restore Event
protected abstract void	processHeartbeatEvent(HeartbeatEvent heartbeatEvent) Abstract method for processing a new Heartbeat Event
protected abstract void	processLogEntryEvent(LogEntryEvent logEntryEvent) Abstract method for processing a new Log Entry Event
protected abstract void	processLogicalDeviceAddedEvent(LogicalDeviceAddedEvent logicalDeviceAddedEvent) Abstract method for processing a new Logical Device Added Event
protected abstract void	processLogicalDeviceRemovedEvent(LogicalDeviceRemovedEvent logicalDeviceRemovedEvent) Abstract method for processing a new Logical Device Removed Event
protected abstract void	processObjectEvent(ObjectEvent objectEvent) Abstract method for processing a new Object Event
protected abstract void	processSensorReadingEvent(SensorReadingEvent sensorReadingEvent) Abstract method for processing a new Sensor Reading Event
protected abstract void	processServiceException(JetstreamResponseException exception) Method for processing exceptions thrown by the service
protected abstract void	processUnknownMessage(java.lang.String message) Abstract method for processing an unknown message
void	StartProcesses() Starts the JetstreamEventService
void	StopProcesses() Stops the JetstreamEventService

Methods inherited from class java.lang.Object

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

Constructor Detail

JetstreamEventService

public JetstreamEventService()

Uses the information in the service.properties file located at the root directory of the implementing project to create a new instance of the JetstreamEventService. The following fields and information must be in the service.properties file

• jetstream.accesskey = YOUR ACCESS KEY
• jetstream.baseuri = YOUR BASE URI
• jetstream.windowtime = YOUR WINDOW TIME

Throws:

java.lang.IllegalArgumentException

JetstreamEventService

public JetstreamEventService(java.io.File properties)

Uses the information in the file passed to the constructor to create a new instance of the JetstreamEventService. The following fields and information must be in the properties file jetstream.accesskey = YOUR ACCESS KEY jetstream.baseuri = YOUR BASE URI jetstream.windowtime = YOUR WINDOW TIME

Parameters:

properties - The properties file containing the information to setup a new JetstreamEventService

Throws:

java.lang.IllegalArgumentException

JetstreamEventService

public JetstreamEventService(java.lang.String baseURI,
                     java.lang.String accessKey,
                     long windowTime)

Uses the information passed to the constructor to create a new instance of the JetstreamEventServcie

Parameters:

baseURI - The baseURI used to communicate with Jetstream

accessKey - The user access key for the application you are using

windowTime - The amount of time in milliseconds between event polling

Throws:

java.lang.IllegalArgumentException

Method Detail

getBaseUri

public java.lang.String getBaseUri()

Returns the base uri currently being used by the servcie to communicate with Jetstream

Returns:

The base uri currently being used to communicate with Jetstream

getAccessKey

public java.lang.String getAccessKey()

Returns the access key being used by the service

Returns:

The access key being used by the service

getWindowTime

public long getWindowTime()

Returns the amount of time in milliseconds between event polling

Returns:

The amount of time in milliseconds between event polling

StartProcesses

public void StartProcesses()

Starts the JetstreamEventService

StopProcesses

public void StopProcesses()

Stops the JetstreamEventService

processAggregateEvent

protected abstract void processAggregateEvent(AggregateEvent aggregateEvent)

Abstract method for processing a new Aggregate Event

Parameters:

aggregateEvent - Deserialized AggregateEvent message in the xsd.exe object model

See Also:

AggregateEvent

processCommandCompletionEvent

protected abstract void processCommandCompletionEvent(CommandCompletionEvent commandCompletionEvent)

Abstract method for processing a new Command Completion Event

Parameters:

commandCompletionEvent - Deserialized CommandCompletionEvent message in the xsd.exe object model

See Also:

CommandCompletionEvent

processCommandQueuedEvent

protected abstract void processCommandQueuedEvent(CommandQueuedEvent commandQueuedEvent)

Abstract method for processing a new Command Queued Event

Parameters:

commandQueuedEvent - Deserialized CommandQueuedEvent message in the xsd.exe object model

See Also:

CommandQueuedEvent

processDeviceFailureEvent

protected abstract void processDeviceFailureEvent(DeviceFailureEvent deviceFailureEvent)

Abstract method for processing a new Device Failure Event

Parameters:

deviceFailureEvent - Deserialized DeviceFailureEvent message in the xsd.exe object model

See Also:

DeviceFailureEvent

processDeviceRestoreEvent

protected abstract void processDeviceRestoreEvent(DeviceRestoreEvent deviceRestoreEvent)

Abstract method for processing a new Device Restore Event

Parameters:

deviceRestoreEvent - Deserialized DeviceRestoreEvent message in the xsd.exe object model

See Also:

DeviceRestoreEvent

processHeartbeatEvent

protected abstract void processHeartbeatEvent(HeartbeatEvent heartbeatEvent)

Abstract method for processing a new Heartbeat Event

Parameters:

heartbeatEvent - Deserialized HeartbeatEvent message in the xsd.exe object model

See Also:

HeartbeatEvent

processLogEntryEvent

protected abstract void processLogEntryEvent(LogEntryEvent logEntryEvent)

Abstract method for processing a new Log Entry Event

Parameters:

logEntryEvent - Deserialized LogEntryEvent message in the xsd.exe object model

See Also:

LogEntryEvent

processLogicalDeviceAddedEvent

protected abstract void processLogicalDeviceAddedEvent(LogicalDeviceAddedEvent logicalDeviceAddedEvent)

Abstract method for processing a new Logical Device Added Event

Parameters:

logicalDeviceAddedEvent - Deserialized LogicalDeviceAddedEvent in the xsd.exe object model

See Also:

LogicalDeviceAddedEvent

processLogicalDeviceRemovedEvent

protected abstract void processLogicalDeviceRemovedEvent(LogicalDeviceRemovedEvent logicalDeviceRemovedEvent)

Abstract method for processing a new Logical Device Removed Event

Parameters:

logicalDeviceRemovedEvent - Deserialized LogicalDeviceRemovedEvent in the xsd.exe object model

See Also:

LogicalDeviceRemovedEvent

processObjectEvent

protected abstract void processObjectEvent(ObjectEvent objectEvent)

Abstract method for processing a new Object Event

Parameters:

objectEvent - Deserialized ObjectEvent in the xsd.exe object model

See Also:

ObjectEvent

processSensorReadingEvent

protected abstract void processSensorReadingEvent(SensorReadingEvent sensorReadingEvent)

Abstract method for processing a new Sensor Reading Event

Parameters:

sensorReadingEvent - Deserialized SensorReadingEvent in the xsd.exe object model

See Also:

SensorReadingEvent

processUnknownMessage

protected abstract void processUnknownMessage(java.lang.String message)

Abstract method for processing an unknown message

Parameters:

message - String representing the unknown message

processServiceException

protected abstract void processServiceException(JetstreamResponseException exception)

Method for processing exceptions thrown by the service

Parameters:

exception - The JetstreamResponseExceptioin thrown by the service

See Also:

JetstreamResponseException