com.bosch.iot.dm.groovy.di

Interface DeviceInventory

public interface DeviceInventory

The main interface to the Device Inventory service.

Method Summary

Modifier and Type	Method and Description
Device	device(java.lang.String deviceId) The device with a given id.
java.util.Iterator<Device>	devices(Selector selector) An iterator over all devices that satisfy the applied selector.
java.util.List<Device>	devices(java.lang.String gatewayId, Selector selector) All devices which have the same gateway identifier and satisfy the applied selector.
int	devicesCount(Selector selector) Count the devices that satisfy the applied selector.
int	devicesCount(java.lang.String gatewayId, Selector selector) Count the devices connected to a gateway which has a given id, which satisfy the applied selector.
void	exec(java.lang.String deviceId, java.lang.String featureId, java.lang.String operationId, java.lang.Object args, AsyncResult result) Used to build asynchronous programming through Continuation Passing Style.
Gateway	gateway(java.lang.String gatewayId) A gateway with a given id or null if not found.
java.util.Iterator<Gateway>	gateways(Selector selector) An iterator over all gateways that satisfy an applied selector.
int	gatewaysCount(Selector selector) Count the gateways that satisfy the applied selector.
boolean	match(java.lang.String deviceId, java.lang.String filter) Check if the device identified by the given id matches the applied filter.
void	message(java.lang.String deviceId, java.lang.String subject, java.lang.String payload) Send opaque message.
void	message(java.lang.String deviceId, java.lang.String featureId, java.lang.String subject, java.lang.String payload) Send opaque message.
void	request(java.lang.String deviceId, java.lang.String subject, java.lang.String payload, AsyncResult result) Send opaque message with response
void	request(java.lang.String deviceId, java.lang.String featureId, java.lang.String subject, java.lang.String payload, AsyncResult result) Send opaque message with response

Method Detail

gateways

java.util.Iterator<Gateway> gateways(Selector selector)

An iterator over all gateways that satisfy an applied selector.

Parameters:

selector - a gateway selector.

Returns:

an iterator over gateways that satisfy an applied selector.

gateway

Gateway gateway(java.lang.String gatewayId)

A gateway with a given id or null if not found.

Parameters:

gatewayId - a gateway id.

Returns:

a gateway with a given identifier or null if not found.

gatewaysCount

int gatewaysCount(Selector selector)

Count the gateways that satisfy the applied selector.

Parameters:

selector - a selector.

Returns:

the number of gateways that satisfy the applied selector.

devices

java.util.Iterator<Device> devices(Selector selector)

An iterator over all devices that satisfy the applied selector.

Parameters:

selector - a device selector.

Returns:

an iterator over all devices that satisfy the applied selector.

devices

java.util.List<Device> devices(java.lang.String gatewayId,
                               Selector selector)

All devices which have the same gateway identifier and satisfy the applied selector.

Parameters:

gatewayId - a gateway identifier.

selector - a gateway selector.

Returns:

devices if some, an empty list if none or ScriptExecutionException if an error occurs.

device

Device device(java.lang.String deviceId)

The device with a given id.

Parameters:

deviceId - a device identifier.

Returns:

a device or ScriptExecutionException if nothing was found.

devicesCount

int devicesCount(Selector selector)

Count the devices that satisfy the applied selector.

Parameters:

selector - a selector.

Returns:

the number of devices that satisfy the applied selector.

devicesCount

int devicesCount(java.lang.String gatewayId,
                 Selector selector)

Count the devices connected to a gateway which has a given id, which satisfy the applied selector.

Parameters:

gatewayId - a gateway identifier.

selector - a selector.

Returns:

The number of devices or ScriptExecutionException if nothing was found.

match

boolean match(java.lang.String deviceId,
              java.lang.String filter)

Check if the device identified by the given id matches the applied filter.

Parameters:

deviceId - the identifier of the device.

filter - the filter against which the device will be matched.

Returns:

true if the device matches the filter, false otherwise.

exec

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

Used to build asynchronous programming through Continuation Passing Style.

Parameters:

deviceId - device id

featureId - feature id

operationId - operation id

args - arguments of the operation

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 deviceId,
             java.lang.String subject,
             java.lang.String payload)

Send opaque message. Fire and forget.

Parameters:

deviceId - deviceId id

subject - message subject

payload - payload

message

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

Send opaque message. Fire and forget.

Parameters:

deviceId - deviceId id

featureId - feature id

subject - message subject

payload - payload

request

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

Send opaque message with response

Parameters:

deviceId - deviceId 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 -> ...}

request

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

Send opaque message with response

Parameters:

deviceId - deviceId id

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 -> ...}