com.sitewhere.spi.device.communication

Interface IDeviceEventDecoder<T>

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

All Known Subinterfaces:

ICompositeDeviceEventDecoder<T>

public interface IDeviceEventDecoder<T>
extends ITenantLifecycleComponent

Decodes inbound device event messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_DEVICE Metadata field used to pass device into nested decoders
static java.lang.String	META_DEVICE_SPECIFICATION Metadata field used to pass device into nested decoders

Method Summary

Modifier and Type	Method and Description
java.util.List<IDecodedDeviceRequest<?>>	decode(T payload, java.util.Map<java.lang.String,java.lang.Object> metadata) Decodes a payload into one or more IDecodedDeviceRequest objects.

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

Field Detail

META_DEVICE

static final java.lang.String META_DEVICE

Metadata field used to pass device into nested decoders

See Also:

Constant Field Values

META_DEVICE_SPECIFICATION

static final java.lang.String META_DEVICE_SPECIFICATION

Metadata field used to pass device into nested decoders

See Also:

Constant Field Values

Method Detail

decode

java.util.List<IDecodedDeviceRequest<?>> decode(T payload,
                                                java.util.Map<java.lang.String,java.lang.Object> metadata)
                                         throws EventDecodeException

Decodes a payload into one or more IDecodedDeviceRequest objects.

Parameters:

payload - the payload that will be decoded

metadata - extra information associated with the payload

Returns:

a list of decoded device requests to be processed

Throws:

EventDecodeException - if the payload can not be decoded