com.bosch.iot.dm.groovy.di

Interface Device

All Known Subinterfaces:

Gateway

public interface Device

Device representation.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	attribute(java.lang.String attributePath) Return the attribute object with the given attribute path or null if not found.
java.util.List<Attribute>	attributes() Return all device attributes.
void	deleteAttribute(java.lang.String attributePath) Deletes the attribute with the specified attribute path.
void	deleteAttributes() Deletes the entity's attributes.
java.lang.String	deviceId() Return device identifier as string <namespace>:<id>
void	exec(java.lang.String featureId, java.lang.String operationId, java.lang.Object args, AsyncResult result) Used to build asynchronous programming through Continuation Passing Style.
Feature	feature(java.lang.String featureId) Return a feature with a given id or null.
java.util.List<Feature>	features() Return device features.
java.util.List<Feature>	features(DefinitionFilter filter) Return all the features that satisfy a given filter or null if not found.
java.util.List<Feature>	features(java.lang.String namespace, java.lang.String name) Return all the features with a given namespace and feature name.
java.util.List<Feature>	features(java.lang.String namespace, java.lang.String name, java.lang.String version) Return all the features with a given namespace, feature name and version.
java.lang.String	gatewayId() Return gateway id.
Identifier	identifier() Return device identifier
void	message(java.lang.String subject, java.lang.String payload) Send opaque message.
void	message(java.lang.String featureId, java.lang.String subject, java.lang.String payload) Send opaque message.
void	request(java.lang.String subject, java.lang.String payload, AsyncResult result) Send opaque message with response
void	request(java.lang.String featureId, java.lang.String subject, java.lang.String payload, AsyncResult result) Send opaque message with response
<T> void	setAttribute(Attribute<T> attribute) Sets the device's attribute to the specified value.
void	setAttributes(java.util.List<Attribute<?>> attributes) Replace all the device's attributes to the specified value.
<T> void	upsertAttribute(Attribute<T> attribute) Deprecated. preferable way is to use setAttribute(Attribute)
void	upsertAttributes(java.util.List<Attribute<?>> attributes) Deprecated. preferable way is to use setAttributes(List)

Method Detail

identifier

Identifier identifier()

Return device identifier

Returns:

the device identifier

deviceId

java.lang.String deviceId()

Return device identifier as string <namespace>:<id>

Returns:

the device identifier as String

gatewayId

java.lang.String gatewayId()

Return gateway id.

Returns:

the gateway identifier or null if not found.

attributes

java.util.List<Attribute> attributes()

Return all device attributes.

Returns:

all device attributes.

attribute

java.lang.Object attribute(java.lang.String attributePath)

Return the attribute object with the given attribute path or null if not found.

Parameters:

attributePath - the searched attribute with a given path.

Returns:

The attribute object or null if not found.

upsertAttribute

<T> void upsertAttribute(Attribute<T> attribute)

Deprecated. preferable way is to use setAttribute(Attribute)

Insert the device's attribute to the specified value. If an attribute with the same path already exists it will be overwritten.

Parameters:

attribute - attribute to be added or updated

setAttribute

<T> void setAttribute(Attribute<T> attribute)

Sets the device's attribute to the specified value. If an attribute with the same path already exists it will be overwritten.

Parameters:

attribute - attribute to be added or updated

upsertAttributes

@Deprecated
void upsertAttributes(java.util.List<Attribute<?>> attributes)

Deprecated. preferable way is to use setAttributes(List)

Insert all the device's attribute to the specified values. All previously existing attributes will be overwritten.

Parameters:

attributes - attributes to be added or updated

setAttributes

void setAttributes(java.util.List<Attribute<?>> attributes)

Replace all the device's attributes to the specified value. All previously existing attributes will be removed!

Parameters:

attributes - attributes to be set

deleteAttribute

void deleteAttribute(java.lang.String attributePath)

Deletes the attribute with the specified attribute path.

Parameters:

attributePath - the path of the attribute to delete

deleteAttributes

void deleteAttributes()

Deletes the entity's attributes.

features

java.util.List<Feature> features()

Return device features.

Returns:

all device features.

features

java.util.List<Feature> features(DefinitionFilter filter)

Return all the features that satisfy a given filter or null if not found.

Parameters:

filter - should not be null.

Returns:

Features that satisfy the applied filter.

features

java.util.List<Feature> features(java.lang.String namespace,
                                 java.lang.String name)

Return all the features with a given namespace and feature name.

Parameters:

namespace - feature namespace.

name - feature name.

Returns:

Features with a given namespace and name.

features

java.util.List<Feature> features(java.lang.String namespace,
                                 java.lang.String name,
                                 java.lang.String version)

Return all the features with a given namespace, feature name and version.

Parameters:

namespace - feature namespace.

name - feature name.

version - feature version.

Returns:

Features that satisfy passed arguments.

See Also:

features(DefinitionFilter)

feature

Feature feature(java.lang.String featureId)

Return a feature with a given id or null.

Parameters:

featureId - feature id.

Returns:

Feature with a given id or null if not found.

exec

void exec(java.lang.String featureId,
          java.lang.String operationId,
          java.lang.Object args,
          AsyncResult result)

Used to build asynchronous programming through Continuation Passing Style.

Parameters:

featureId - feature id.

operationId - operation id.

args - needed operation parameters.

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

message

void message(java.lang.String subject,
             java.lang.String payload)

Send opaque message. Fire and forget.

Parameters:

subject - message subject

payload - payload

message

void message(java.lang.String featureId,
             java.lang.String subject,
             java.lang.String payload)

Send opaque message. Fire and forget

Parameters:

featureId - feature id

subject - message subject

payload - payload

request

void request(java.lang.String subject,
             java.lang.String payload,
             AsyncResult result)

Send opaque message with response

Parameters:

subject - message subject

payload - payload

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

request

void request(java.lang.String featureId,
             java.lang.String subject,
             java.lang.String payload,
             AsyncResult result)

Send opaque message with response

Parameters:

featureId - feature id

subject - message subject

payload - payload

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}