org.eclipse.soda.dk.device.service
Interface DeviceRegistryService

All Superinterfaces:

ControlService, DeviceService

All Known Implementing Classes:

DeviceRegistry

public interface DeviceRegistryService
extends DeviceService

The DeviceRegistryService interface defines the DeviceManagerService concept. A DeviceManagerService encapsulates many DeviceServices. The DeviceManagerService provides access to all of the Commands, Measurements, and Signals which are available from its constituent DeviceServices. A DeviceManagerService may also contain its own Controls.

Version:

1.0.0

See Also:

DeviceRegistry, DeviceService

Field Summary

static java.lang.String

SERVICE_NAME Define the OSGi service name.

Fields inherited from interface org.eclipse.soda.dk.device.service.DeviceService

ACTIVE, ALIVE, ALL_COMMANDS, ALL_MEASUREMENTS, ALL_SIGNALS, AUTOSTART, BLOCKPROCESSING, Capabilities, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, CAPABILITIES_READ_EXTERNAL_KEY, CAPABILITIES_WRITE_EXTERNAL_KEY, Configuration, CONFIGURATION_DATA_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, CONFIGURATION_READ_EXTERNAL_KEY, CONFIGURATION_WRITE_EXTERNAL_KEY, CONNECTED, CREATED, DEAD, ERROR_EXTERNAL_KEY, EVENPROCESSING, EXECUTE_EXTERNAL_KEY, GET_EXTERNAL_KEY, INITIALIZEMEASUREMENTS, KEYS_DATA_KEY, NULL, READ_EXTERNAL_KEY, RECEIVED_KEY_DATA_KEY, SET_EXTERNAL_KEY, SOURCE_DATA_KEY, STARTED, STATE_DATA_KEY, STATE_OLD_DATA_KEY, Status, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, STATUS_READ_EXTERNAL_KEY, STATUS_WRITE_EXTERNAL_KEY, TIMESTAMP_DATA_KEY, TRIGGER_EXTERNAL_KEY, VALUE_DATA_KEY, VALUE_OLD_DATA_KEY, WRITE_EXTERNAL_KEY

Method Summary

CommandService	getCommand(java.lang.String key) Perform the getCommand method and return the CommandService result.
DeviceService	getDevice(java.lang.String key) Perform the getDevice method and return the CommandService result.
MeasurementService	getMeasurement(java.lang.String key) Perform the getMeasurement method and return the MeasurementService result.
SignalService	getSignal(java.lang.String key) Perform the getSignal method and return the SignalService result.
void	put(java.lang.String key, ControlService control) Perform the put action method.
void	remove(java.lang.String key) Perform the remove action method.

Methods inherited from interface org.eclipse.soda.dk.device.service.DeviceService

addDeviceListener, elements, exit, get, getConfigurationInformation, getNotificationService, getState, getTransport, isStarted, removeDeviceListener, send, setConfigurationInformation, setNotificationService, setTransport, start, stop

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Define the OSGi service name.

Method Detail

getCommand

CommandService getCommand(java.lang.String key)

Perform the getCommand method and return the CommandService result. This method returns the CommandService contained within the DeviceServiceManager or one of its constituent DeviceServices, whose key matches the key argument.

Specified by:

getCommand in interface DeviceService

Parameters:

key - String

Returns:

Results of the get command (CommandService) value.

getDevice

DeviceService getDevice(java.lang.String key)

Perform the getDevice method and return the CommandService result. This method returns a DeviceService contained within this DeviceServiceManager, whose key is equal to the key argument.

Parameters:

key - String

Returns:

Results of the get device (DeviceService) value.

getMeasurement

MeasurementService getMeasurement(java.lang.String key)

Perform the getMeasurement method and return the MeasurementService result. This method returns the MeasurementService contained within the DeviceServiceManager or one of its constituent DeviceServices, whose key matches the key argument.

Specified by:

getMeasurement in interface DeviceService

Parameters:

key - String

Returns:

Results of the get measurement (MeasurementService) value.

getSignal

SignalService getSignal(java.lang.String key)

Perform the getSignal method and return the SignalService result. This method returns the SignalService contained within the DeviceServiceManager or one of its constituent DeviceServices, whose key matches the key argument.

Specified by:

getSignal in interface DeviceService

Parameters:

key - String

Returns:

Results of the get signal (SignalService) value.

put

void put(java.lang.String key,
         ControlService control)

Perform the put action method. This method places a new ControlService in the DeviceServiceManager's list of controls, with a key value equals to the key arguement.

Specified by:

put in interface DeviceService

Parameters:

key - java.lang.String

control - org.eclipse.soda.dk.device.service.ControlService

remove

void remove(java.lang.String key)

Perform the remove action method. This method removes the ControlService from the DeviceServiceManager's list of Controls whose key matches the key arguement.

Specified by:

remove in interface DeviceService

Parameters:

key - String