com.sitewhere.spi.device.communication

Interface ICommandDestination<T,P>

Type Parameters:

T -

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface ICommandDestination<T,P>
extends ITenantLifecycleComponent

Delivers commands to devices by encoding the commands, finding the list of target devices, then using a delivery provider to send the encoded commands.

Method Summary

Modifier and Type	Method and Description
void	deliverCommand(IDeviceCommandExecution execution, IDeviceNestingContext nesting, IDeviceAssignment assignment) Deliver a command.
void	deliverSystemCommand(ISystemCommand command, IDeviceNestingContext nesting, IDeviceAssignment assignment) Deliver a system command.
ICommandDeliveryParameterExtractor<P>	getCommandDeliveryParameterExtractor() Get the configured command delivery parameter extractor.
ICommandDeliveryProvider<T,P>	getCommandDeliveryProvider() Gets the configured command delivery provider.
ICommandExecutionEncoder<T>	getCommandExecutionEncoder() Gets the configured command execution encoder.
java.lang.String	getDestinationId() Get unique identifier for destination.

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

getDestinationId

java.lang.String getDestinationId()

Get unique identifier for destination.

Returns:

getCommandExecutionEncoder

ICommandExecutionEncoder<T> getCommandExecutionEncoder()

Gets the configured command execution encoder.

Returns:

getCommandDeliveryParameterExtractor

ICommandDeliveryParameterExtractor<P> getCommandDeliveryParameterExtractor()

Get the configured command delivery parameter extractor.

Returns:

getCommandDeliveryProvider

ICommandDeliveryProvider<T,P> getCommandDeliveryProvider()

Gets the configured command delivery provider.

Returns:

deliverCommand

void deliverCommand(IDeviceCommandExecution execution,
                    IDeviceNestingContext nesting,
                    IDeviceAssignment assignment)
             throws SiteWhereException

Deliver a command.

Parameters:

execution -

nesting -

assignment -

Throws:

SiteWhereException

deliverSystemCommand

void deliverSystemCommand(ISystemCommand command,
                          IDeviceNestingContext nesting,
                          IDeviceAssignment assignment)
                   throws SiteWhereException

Deliver a system command.

Parameters:

command -

nesting -

assignment -

Throws:

SiteWhereException