org.eclipse.soda.dk.profile.service
Interface ProfileService

All Known Implementing Classes:

DeviceProfile, Profile

public interface ProfileService

Since:

1.0

Version:

1.2.0

Field Summary

static int	ACTIVE Define the ACTIVE state value.
static int	ALIVE Define the ALIVE state value.
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	CHANNEL_CHANGED_EXTERNAL_KEY Define the channel changed external key (String) constant.
static java.lang.String	CHANNEL_EXTERNAL_ID_DATA_KEY Define the channel external id data key (String) constant.
static java.lang.String	CHANNEL_ID_DATA_KEY Define the channel id data key (String) constant.
static java.lang.String	ChannelChanged Defines the Channel Changed signal.
static java.lang.String	Channels Defines the Channels measurement.
static java.lang.String	CHANNELS_EXTERNAL_KEY Define the channels external key (String) constant.
static java.lang.String	CHANNELS_GET_EXTERNAL_KEY Define the channels get external key (String) constant.
static java.lang.String	CHANNELS_READ_EXTERNAL_KEY Define the channels read external key (String) constant.
static java.lang.String	CHANNELS_WRITE_EXTERNAL_KEY Define the channels write external key (String) constant.
static java.lang.String	CLOSE_CHANNEL_EXTERNAL_KEY Define the close channel external key (String) constant.
static java.lang.String	CloseChannel Defines the Close Channel command.
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 int	CONNECTED Define the CONNECTED state value.
static int	CREATED Define the CREATED state value.
static int	DEAD Define the DEAD state value.
static java.lang.String	Metrics Define the Position Profile Metrics measurement.
static java.lang.String	METRICS_ERROR_EXTERNAL_KEY Define the Position Profile Metrics measurement.
static java.lang.String	METRICS_EXTERNAL_KEY Define the Position Profile Metrics measurement.
static java.lang.String	METRICS_GET_EXTERNAL_KEY Define the Position Profile Metrics measurement.
static java.lang.String	OPEN_CHANNEL_EXTERNAL_KEY Define the open channel external key (String) constant.
static java.lang.String	OpenChannel Defines the Open Channel command.
static java.lang.String	SERVICE_NAME Define the service name (String) constant.
static int	STARTED Define the STARTED state value.
static java.lang.String	STATE_DATA_KEY Define the state data key (String) constant.
static java.lang.String	STATE_OLD_DATA_KEY Define the state old data key (String) constant.
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.

Method Summary

void	exit() Exit.
ChannelService	getChannel(java.lang.String channelId) Get channel with the specified channel id parameter and return the ChannelService result.
java.util.Dictionary	getConfigurationInformation() Gets the configuration information (Dictionary) value.
java.lang.String	getKey() Gets the key (String) value.
org.eclipse.soda.dk.notification.service.NotificationService	getNotificationService() Gets the notification service value.
ProfileListener	getProfileListener() Gets the profile listener value.
int	getState() Gets the int state of the ProfileService.
ChannelService	openChannel(java.util.Map parameters) Open channel with the specified channel spec parameter and return the ChannelService result.
void	setConfigurationInformation(java.util.Dictionary configurationInformation) Set the configuration information.
void	setNotificationService(org.eclipse.soda.dk.notification.service.NotificationService notificationService) Sets the notification service value.
void	start() Start.
void	stop() Stop.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Define the service name (String) constant.

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:

NotificationService.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:

NotificationService.GET_EXTERNAL_KEY, NotificationService.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:

NotificationService.GET_EXTERNAL_KEY, NotificationService.READ_EXTERNAL_KEY, NotificationService.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:

NotificationService.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:

NotificationService.GET_EXTERNAL_KEY, NotificationService.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:

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

Metrics

static final java.lang.String Metrics

Define the Position Profile Metrics measurement.

See Also:

Constant Field Values

METRICS_EXTERNAL_KEY

static final java.lang.String METRICS_EXTERNAL_KEY

Define the Position Profile Metrics measurement.

See Also:

Constant Field Values

METRICS_GET_EXTERNAL_KEY

static final java.lang.String METRICS_GET_EXTERNAL_KEY

Define the Position Profile Metrics measurement.

See Also:

Constant Field Values

METRICS_ERROR_EXTERNAL_KEY

static final java.lang.String METRICS_ERROR_EXTERNAL_KEY

Define the Position Profile Metrics measurement.

See Also:

NotificationService.GET_EXTERNAL_KEY, value of this field is "prefix/Profile/Metrics/error", 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:

NotificationService.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:

NotificationService.GET_EXTERNAL_KEY, NotificationService.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:

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

ACTIVE

static final int ACTIVE

Define the ACTIVE state value. In the ACTIVE state, the device object is connected and is processing input.

See Also:

Constant Field Values

ALIVE

static final int ALIVE

Define the ALIVE state value. In the ALIVE state, the device object was been created and is running.

See Also:

Constant Field Values

CONNECTED

static final int CONNECTED

Define the CONNECTED state value. In the CONNECTED state, the device object is connected to the transport.

See Also:

Constant Field Values

CREATED

static final int CREATED

Define the CREATED state value. In the CREATED state, the device object has been created.

See Also:

Constant Field Values

DEAD

static final int DEAD

Define the DEAD state value.

See Also:

Constant Field Values

STARTED

static final int STARTED

Define the STARTED state value. In the STARTED state, the device object is started.

See Also:

Constant Field Values

STATE_DATA_KEY

static final java.lang.String STATE_DATA_KEY

Define the state data key (String) constant.

See Also:

Constant Field Values

STATE_OLD_DATA_KEY

static final java.lang.String STATE_OLD_DATA_KEY

Define the state old data key (String) constant.

See Also:

Constant Field Values

CHANNEL_ID_DATA_KEY

static final java.lang.String CHANNEL_ID_DATA_KEY

Define the channel id data key (String) constant.

Since:

1.2

See Also:

Constant Field Values

CHANNEL_EXTERNAL_ID_DATA_KEY

static final java.lang.String CHANNEL_EXTERNAL_ID_DATA_KEY

Define the channel external id data key (String) constant.

Since:

1.2

See Also:

Constant Field Values

Channels

static final java.lang.String Channels

Defines the Channels measurement.

Since:

1.2

See Also:

Constant Field Values

CHANNELS_EXTERNAL_KEY

static final java.lang.String CHANNELS_EXTERNAL_KEY

Define the channels external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

CHANNELS_GET_EXTERNAL_KEY

static final java.lang.String CHANNELS_GET_EXTERNAL_KEY

Define the channels get external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

CHANNELS_READ_EXTERNAL_KEY

static final java.lang.String CHANNELS_READ_EXTERNAL_KEY

Define the channels read external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

CHANNELS_WRITE_EXTERNAL_KEY

static final java.lang.String CHANNELS_WRITE_EXTERNAL_KEY

Define the channels write external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

ChannelChanged

static final java.lang.String ChannelChanged

Defines the Channel Changed signal.

Since:

1.2

See Also:

Constant Field Values

CHANNEL_CHANGED_EXTERNAL_KEY

static final java.lang.String CHANNEL_CHANGED_EXTERNAL_KEY

Define the channel changed external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

OpenChannel

static final java.lang.String OpenChannel

Defines the Open Channel command.

Since:

1.2

See Also:

Constant Field Values

OPEN_CHANNEL_EXTERNAL_KEY

static final java.lang.String OPEN_CHANNEL_EXTERNAL_KEY

Define the open channel external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

CloseChannel

static final java.lang.String CloseChannel

Defines the Close Channel command.

Since:

1.2

See Also:

Constant Field Values

CLOSE_CHANNEL_EXTERNAL_KEY

static final java.lang.String CLOSE_CHANNEL_EXTERNAL_KEY

Define the close channel external key (String) constant.

Since:

1.2

See Also:

Constant Field Values

Method Detail

exit

void exit()

Exit.

getChannel

ChannelService getChannel(java.lang.String channelId)

Get channel with the specified channel id parameter and return the ChannelService result.

Parameters:

channelId - The channel ID (String) parameter.

Returns:

Results of the get channel (ChannelService) value.

Since:

1.2

See Also:

openChannel(Map)

getConfigurationInformation

java.util.Dictionary getConfigurationInformation()

Gets the configuration information (Dictionary) value.

Returns:

Configuration Information.

See Also:

setConfigurationInformation(Dictionary)

getKey

java.lang.String getKey()

Gets the key (String) value.

Returns:

The key (String) value.

getNotificationService

org.eclipse.soda.dk.notification.service.NotificationService getNotificationService()

Gets the notification service value.

Returns:

The notification service (NotificationService) value.

See Also:

setNotificationService(NotificationService)

getProfileListener

ProfileListener getProfileListener()

Gets the profile listener value.

Returns:

The profile listener (ProfileListener) value.

Since:

1.2

getState

int getState()

Gets the int state of the ProfileService.

Returns:

int The state of the ProfileService.

openChannel

ChannelService openChannel(java.util.Map parameters)
                           throws java.io.IOException

Open channel with the specified channel spec parameter and return the ChannelService result.

Parameters:

parameters - The parameters (Map) parameter.

Returns:

Results of the open channel (ChannelService) value.

Throws:

java.io.IOException - IOException.

Since:

1.2

See Also:

getChannel(String)

setConfigurationInformation

void setConfigurationInformation(java.util.Dictionary configurationInformation)

Set the configuration information.

Parameters:

configurationInformation - The configuration information (Dictionary) parameter.

See Also:

getConfigurationInformation()

setNotificationService

void setNotificationService(org.eclipse.soda.dk.notification.service.NotificationService notificationService)

Sets the notification service value.

Parameters:

notificationService - The notification service (NotificationService) parameter.

See Also:

getNotificationService()

start

void start()

Start.

stop

void stop()

Stop.