org.eclipse.soda.dk.adapter.service
Interface AdapterService

All Superinterfaces:

ControlService, DeviceService

All Known Implementing Classes:

Adapter, DeviceAdapter, TestAdapter

public interface AdapterService
extends DeviceService

Since:

1.0

Version:

1.2.0

Field Summary

static java.lang.String[]	ALL_COMMANDS Comprehensive list of all the command identifiers.
static java.lang.String[]	ALL_MEASUREMENTS Comprehensive list of all the measurement identifiers.
static java.lang.String[]	ALL_SIGNALS Comprehensive list of all the signal identifiers.
static java.lang.String	Capabilities Defines the Capabilities measurement.
static java.lang.String	CAPABILITIES_EXTERNAL_KEY Defines the Capabilities measurement.
static java.lang.String	CAPABILITIES_GET_EXTERNAL_KEY Defines the Capabilities measurement.
static java.lang.String	CAPABILITIES_READ_EXTERNAL_KEY Defines the Capabilities measurement.
static java.lang.String	CAPABILITIES_WRITE_EXTERNAL_KEY Defines the Capabilities measurement.
static java.lang.String	Configuration Defines the Configuration measurement.
static java.lang.String	CONFIGURATION_EXTERNAL_KEY Defines the Configuration measurement.
static java.lang.String	CONFIGURATION_GET_EXTERNAL_KEY Defines the Configuration measurement.
static java.lang.String	CONFIGURATION_READ_EXTERNAL_KEY Defines the Configuration measurement.
static java.lang.String	CONFIGURATION_WRITE_EXTERNAL_KEY Defines the Configuration measurement.
static java.lang.String	Metrics Define the Adapter Metrics measurement.
static java.lang.String	METRICS_ERROR_EXTERNAL_KEY Define the Adapter Metrics measurement.
static java.lang.String	METRICS_EXTERNAL_KEY Define the Adapter Metrics measurement.
static java.lang.String	METRICS_GET_EXTERNAL_KEY Define the Adapter Metrics measurement.
static java.lang.String	SERVICE_NAME Define the OSGi service name.
static java.lang.String	Status Defines the Status measurement.
static java.lang.String	STATUS_EXTERNAL_KEY Defines the Status measurement.
static java.lang.String	STATUS_GET_EXTERNAL_KEY Defines the Status measurement.
static java.lang.String	STATUS_READ_EXTERNAL_KEY Defines the Status measurement.
static java.lang.String	STATUS_WRITE_EXTERNAL_KEY Defines the Status measurement.

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

ACTIVE, ALIVE, AUTOSTART, BLOCKPROCESSING, BROADCAST_COMMAND_COUNT_DATA_KEY, BROADCAST_MEASUREMENT_COUNT_DATA_KEY, BROADCAST_SIGNAL_COUNT_DATA_KEY, CHANNEL_CHANGED_EXTERNAL_KEY, CHANNEL_EXTERNAL_ID_DATA_KEY, CHANNEL_ID_DATA_KEY, ChannelChanged, Channels, CHANNELS_EXTERNAL_KEY, CHANNELS_GET_EXTERNAL_KEY, CHANNELS_READ_EXTERNAL_KEY, CHANNELS_WRITE_EXTERNAL_KEY, CLOSE_CHANNEL_EXTERNAL_KEY, CloseChannel, CONFIGURATION_DATA_KEY, CONNECTED, CREATED, DEAD, ERROR_EXTERNAL_KEY, EVENPROCESSING, EXECUTE_EXTERNAL_KEY, GET_EXTERNAL_KEY, INITIALIZEMEASUREMENTS, KEYS_DATA_KEY, NULL, OPEN_CHANNEL_EXTERNAL_KEY, OpenChannel, READ_EXTERNAL_KEY, RECEIVED_KEY_DATA_KEY, SET_EXTERNAL_KEY, SOURCE_DATA_KEY, STARTED, STATE_DATA_KEY, STATE_OLD_DATA_KEY, TIMESTAMP_DATA_KEY, TRIGGER_EXTERNAL_KEY, VALUE_DATA_KEY, VALUE_OLD_DATA_KEY, WRITE_EXTERNAL_KEY

Method Summary

DeviceService	getDevice() Gets the device (DeviceService) value.
void	setDevice(DeviceService device) Sets the device value.

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

addDeviceListener, closeChannel, elements, exit, get, getChannel, getCommand, getConfigurationInformation, getMeasurement, getNotificationService, getSignal, getState, getTransport, isStarted, openChannel, put, remove, removeDeviceListener, send, send, send, 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.

ALL_COMMANDS

static final java.lang.String[] ALL_COMMANDS

Comprehensive list of all the command identifiers.

ALL_MEASUREMENTS

static final java.lang.String[] ALL_MEASUREMENTS

Comprehensive list of all the measurement identifiers.

ALL_SIGNALS

static final java.lang.String[] ALL_SIGNALS

Comprehensive list of all the signal identifiers.

Capabilities

static final java.lang.String Capabilities

Defines the Capabilities measurement.

See Also:

Constant Field Values

CAPABILITIES_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_EXTERNAL_KEY

Defines the Capabilities measurement.

See Also:

Constant Field Values

CAPABILITIES_GET_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_GET_EXTERNAL_KEY

Defines the Capabilities measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, Constant Field Values

CAPABILITIES_READ_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_READ_EXTERNAL_KEY

Defines the Capabilities measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, Constant Field Values

CAPABILITIES_WRITE_EXTERNAL_KEY

static final java.lang.String CAPABILITIES_WRITE_EXTERNAL_KEY

Defines the Capabilities measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, DeviceService.WRITE_EXTERNAL_KEY, Constant Field Values

Configuration

static final java.lang.String Configuration

Defines the Configuration measurement.

See Also:

Constant Field Values

CONFIGURATION_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_EXTERNAL_KEY

Defines the Configuration measurement.

See Also:

Constant Field Values

CONFIGURATION_GET_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_GET_EXTERNAL_KEY

Defines the Configuration measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, Constant Field Values

CONFIGURATION_READ_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_READ_EXTERNAL_KEY

Defines the Configuration measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, Constant Field Values

CONFIGURATION_WRITE_EXTERNAL_KEY

static final java.lang.String CONFIGURATION_WRITE_EXTERNAL_KEY

Defines the Configuration measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, DeviceService.WRITE_EXTERNAL_KEY, Constant Field Values

Metrics

static final java.lang.String Metrics

Define the Adapter Metrics measurement.

See Also:

Constant Field Values

METRICS_EXTERNAL_KEY

static final java.lang.String METRICS_EXTERNAL_KEY

Define the Adapter Metrics measurement. The value of this field is "prefix/Adapter/Metrics"

See Also:

Constant Field Values

METRICS_GET_EXTERNAL_KEY

static final java.lang.String METRICS_GET_EXTERNAL_KEY

Define the Adapter Metrics measurement. The value of this field is "prefix/Adapter/Metrics/get"

See Also:

Constant Field Values

METRICS_ERROR_EXTERNAL_KEY

static final java.lang.String METRICS_ERROR_EXTERNAL_KEY

Define the Adapter Metrics measurement. The value of this field is "prefix/Adapter/Metrics/error"

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.ERROR_EXTERNAL_KEY, Constant Field Values

Status

static final java.lang.String Status

Defines the Status measurement.

See Also:

Constant Field Values

STATUS_EXTERNAL_KEY

static final java.lang.String STATUS_EXTERNAL_KEY

Defines the Status measurement.

See Also:

Constant Field Values

STATUS_GET_EXTERNAL_KEY

static final java.lang.String STATUS_GET_EXTERNAL_KEY

Defines the Status measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, Constant Field Values

STATUS_READ_EXTERNAL_KEY

static final java.lang.String STATUS_READ_EXTERNAL_KEY

Defines the Status measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, Constant Field Values

STATUS_WRITE_EXTERNAL_KEY

static final java.lang.String STATUS_WRITE_EXTERNAL_KEY

Defines the Status measurement.

See Also:

DeviceService.GET_EXTERNAL_KEY, DeviceService.READ_EXTERNAL_KEY, DeviceService.WRITE_EXTERNAL_KEY, Constant Field Values

Method Detail

getDevice

DeviceService getDevice()

Gets the device (DeviceService) value.

Returns:

The device (DeviceService) value.

See Also:

setDevice(DeviceService)

setDevice

void setDevice(DeviceService device)

Sets the device value.

Parameters:

device - The device (DeviceService) parameter.

See Also:

getDevice()