com.sitewhere.spi.device.event

Interface IDeviceEventManagement

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IDeviceEventManagement
extends ITenantLifecycleComponent

Interface for device event management operations.

Method Summary

Modifier and Type	Method and Description
IDeviceAlert	addDeviceAlert(java.lang.String assignmentToken, IDeviceAlertCreateRequest request) Add alert for a given device assignment.
IDeviceCommandInvocation	addDeviceCommandInvocation(java.lang.String assignmentToken, IDeviceCommand command, IDeviceCommandInvocationCreateRequest request) Add a device command invocation event for the given assignment.
IDeviceCommandResponse	addDeviceCommandResponse(java.lang.String assignmentToken, IDeviceCommandResponseCreateRequest request) Adds a new device command response event.
IDeviceEventBatchResponse	addDeviceEventBatch(java.lang.String assignmentToken, IDeviceEventBatch batch) Add a batch of events for the given assignment.
IDeviceLocation	addDeviceLocation(java.lang.String assignmentToken, IDeviceLocationCreateRequest request) Add location for a given device assignment.
IDeviceMeasurements	addDeviceMeasurements(java.lang.String assignmentToken, IDeviceMeasurementsCreateRequest measurements) Add measurements for a given device assignment.
IDeviceStateChange	addDeviceStateChange(java.lang.String assignmentToken, IDeviceStateChangeCreateRequest request) Adds a new device state change event.
IDeviceStreamData	addDeviceStreamData(java.lang.String assignmentToken, IDeviceStreamDataCreateRequest request) Add a chunk of stream data for a given device assignment.
IDeviceEvent	getDeviceEventById(java.lang.String id) Get a device event by unique id.
IDeviceManagement	getDeviceManagement() Get the device management implementation.
IDeviceStreamData	getDeviceStreamData(java.lang.String assignmentToken, java.lang.String streamId, long sequenceNumber) Get a single chunk of data from a device stream.
ISearchResults<IDeviceAlert>	listDeviceAlerts(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets the most recent device alert entries for an assignment.
ISearchResults<IDeviceAlert>	listDeviceAlertsForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device alerts for a site.
ISearchResults<IDeviceCommandResponse>	listDeviceCommandInvocationResponses(java.lang.String invocationId) List responses associated with a command invocation.
ISearchResults<IDeviceCommandInvocation>	listDeviceCommandInvocations(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets device command invocations for an assignment based on criteria.
ISearchResults<IDeviceCommandInvocation>	listDeviceCommandInvocationsForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device command invocations for a site.
ISearchResults<IDeviceCommandResponse>	listDeviceCommandResponses(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets the most recent device command response entries for an assignment.
ISearchResults<IDeviceCommandResponse>	listDeviceCommandResponsesForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device command responses for a site.
ISearchResults<IDeviceEvent>	listDeviceEvents(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) List all events for the given assignment that meet the search criteria.
ISearchResults<IDeviceLocation>	listDeviceLocations(java.util.List<java.lang.String> assignmentTokens, IDateRangeSearchCriteria criteria) List device locations for the given tokens within the given time range.
ISearchResults<IDeviceLocation>	listDeviceLocations(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets device location entries for an assignment.
ISearchResults<IDeviceLocation>	listDeviceLocationsForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device locations for a site.
ISearchResults<IDeviceMeasurements>	listDeviceMeasurements(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets device measurement entries for an assignment based on criteria.
ISearchResults<IDeviceMeasurements>	listDeviceMeasurementsForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device measurements for a site.
ISearchResults<IDeviceStateChange>	listDeviceStateChanges(java.lang.String assignmentToken, IDateRangeSearchCriteria criteria) Gets the most recent device state change entries for an assignment.
ISearchResults<IDeviceStateChange>	listDeviceStateChangesForSite(java.lang.String siteToken, IDateRangeSearchCriteria criteria) List device state changes for a site.
ISearchResults<IDeviceStreamData>	listDeviceStreamData(java.lang.String assignmentToken, java.lang.String streamId, IDateRangeSearchCriteria criteria) List all chunks of data in a device assignment that belong to a given stream and meet the criteria.
void	setDeviceManagement(IDeviceManagement deviceManagement) Set the device management implementation.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

setDeviceManagement

void setDeviceManagement(IDeviceManagement deviceManagement)
                  throws SiteWhereException

Set the device management implementation.

Parameters:

deviceManagement -

Throws:

SiteWhereException

getDeviceManagement

IDeviceManagement getDeviceManagement()
                               throws SiteWhereException

Get the device management implementation.

Returns:

Throws:

SiteWhereException

addDeviceEventBatch

IDeviceEventBatchResponse addDeviceEventBatch(java.lang.String assignmentToken,
                                              IDeviceEventBatch batch)
                                       throws SiteWhereException

Add a batch of events for the given assignment.

Parameters:

assignmentToken -

batch -

Returns:

Throws:

SiteWhereException

getDeviceEventById

IDeviceEvent getDeviceEventById(java.lang.String id)
                         throws SiteWhereException

Get a device event by unique id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

listDeviceEvents

ISearchResults<IDeviceEvent> listDeviceEvents(java.lang.String assignmentToken,
                                              IDateRangeSearchCriteria criteria)
                                       throws SiteWhereException

List all events for the given assignment that meet the search criteria.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceMeasurements

IDeviceMeasurements addDeviceMeasurements(java.lang.String assignmentToken,
                                          IDeviceMeasurementsCreateRequest measurements)
                                   throws SiteWhereException

Add measurements for a given device assignment.

Parameters:

assignmentToken -

measurements -

Returns:

Throws:

SiteWhereException

listDeviceMeasurements

ISearchResults<IDeviceMeasurements> listDeviceMeasurements(java.lang.String assignmentToken,
                                                           IDateRangeSearchCriteria criteria)
                                                    throws SiteWhereException

Gets device measurement entries for an assignment based on criteria.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceMeasurementsForSite

ISearchResults<IDeviceMeasurements> listDeviceMeasurementsForSite(java.lang.String siteToken,
                                                                  IDateRangeSearchCriteria criteria)
                                                           throws SiteWhereException

List device measurements for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceLocation

IDeviceLocation addDeviceLocation(java.lang.String assignmentToken,
                                  IDeviceLocationCreateRequest request)
                           throws SiteWhereException

Add location for a given device assignment.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

listDeviceLocations

ISearchResults<IDeviceLocation> listDeviceLocations(java.lang.String assignmentToken,
                                                    IDateRangeSearchCriteria criteria)
                                             throws SiteWhereException

Gets device location entries for an assignment.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceLocationsForSite

ISearchResults<IDeviceLocation> listDeviceLocationsForSite(java.lang.String siteToken,
                                                           IDateRangeSearchCriteria criteria)
                                                    throws SiteWhereException

List device locations for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceLocations

ISearchResults<IDeviceLocation> listDeviceLocations(java.util.List<java.lang.String> assignmentTokens,
                                                    IDateRangeSearchCriteria criteria)
                                             throws SiteWhereException

List device locations for the given tokens within the given time range.

Parameters:

assignmentTokens -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceAlert

IDeviceAlert addDeviceAlert(java.lang.String assignmentToken,
                            IDeviceAlertCreateRequest request)
                     throws SiteWhereException

Add alert for a given device assignment.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

listDeviceAlerts

ISearchResults<IDeviceAlert> listDeviceAlerts(java.lang.String assignmentToken,
                                              IDateRangeSearchCriteria criteria)
                                       throws SiteWhereException

Gets the most recent device alert entries for an assignment.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceAlertsForSite

ISearchResults<IDeviceAlert> listDeviceAlertsForSite(java.lang.String siteToken,
                                                     IDateRangeSearchCriteria criteria)
                                              throws SiteWhereException

List device alerts for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceStreamData

IDeviceStreamData addDeviceStreamData(java.lang.String assignmentToken,
                                      IDeviceStreamDataCreateRequest request)
                               throws SiteWhereException

Add a chunk of stream data for a given device assignment.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

getDeviceStreamData

IDeviceStreamData getDeviceStreamData(java.lang.String assignmentToken,
                                      java.lang.String streamId,
                                      long sequenceNumber)
                               throws SiteWhereException

Get a single chunk of data from a device stream.

Parameters:

assignmentToken -

streamId -

sequenceNumber -

Returns:

Throws:

SiteWhereException

listDeviceStreamData

ISearchResults<IDeviceStreamData> listDeviceStreamData(java.lang.String assignmentToken,
                                                       java.lang.String streamId,
                                                       IDateRangeSearchCriteria criteria)
                                                throws SiteWhereException

List all chunks of data in a device assignment that belong to a given stream and meet the criteria.

Parameters:

assignmentToken -

streamId -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceCommandInvocation

IDeviceCommandInvocation addDeviceCommandInvocation(java.lang.String assignmentToken,
                                                    IDeviceCommand command,
                                                    IDeviceCommandInvocationCreateRequest request)
                                             throws SiteWhereException

Add a device command invocation event for the given assignment.

Parameters:

assignmentToken -

command -

request -

Returns:

Throws:

SiteWhereException

listDeviceCommandInvocations

ISearchResults<IDeviceCommandInvocation> listDeviceCommandInvocations(java.lang.String assignmentToken,
                                                                      IDateRangeSearchCriteria criteria)
                                                               throws SiteWhereException

Gets device command invocations for an assignment based on criteria.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceCommandInvocationsForSite

ISearchResults<IDeviceCommandInvocation> listDeviceCommandInvocationsForSite(java.lang.String siteToken,
                                                                             IDateRangeSearchCriteria criteria)
                                                                      throws SiteWhereException

List device command invocations for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceCommandInvocationResponses

ISearchResults<IDeviceCommandResponse> listDeviceCommandInvocationResponses(java.lang.String invocationId)
                                                                     throws SiteWhereException

List responses associated with a command invocation.

Parameters:

invocationId -

Returns:

Throws:

SiteWhereException

addDeviceCommandResponse

IDeviceCommandResponse addDeviceCommandResponse(java.lang.String assignmentToken,
                                                IDeviceCommandResponseCreateRequest request)
                                         throws SiteWhereException

Adds a new device command response event.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

listDeviceCommandResponses

ISearchResults<IDeviceCommandResponse> listDeviceCommandResponses(java.lang.String assignmentToken,
                                                                  IDateRangeSearchCriteria criteria)
                                                           throws SiteWhereException

Gets the most recent device command response entries for an assignment.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceCommandResponsesForSite

ISearchResults<IDeviceCommandResponse> listDeviceCommandResponsesForSite(java.lang.String siteToken,
                                                                         IDateRangeSearchCriteria criteria)
                                                                  throws SiteWhereException

List device command responses for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

addDeviceStateChange

IDeviceStateChange addDeviceStateChange(java.lang.String assignmentToken,
                                        IDeviceStateChangeCreateRequest request)
                                 throws SiteWhereException

Adds a new device state change event.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

listDeviceStateChanges

ISearchResults<IDeviceStateChange> listDeviceStateChanges(java.lang.String assignmentToken,
                                                          IDateRangeSearchCriteria criteria)
                                                   throws SiteWhereException

Gets the most recent device state change entries for an assignment.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceStateChangesForSite

ISearchResults<IDeviceStateChange> listDeviceStateChangesForSite(java.lang.String siteToken,
                                                                 IDateRangeSearchCriteria criteria)
                                                          throws SiteWhereException

List device state changes for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException