org.eclipse.soda.dk.device
Class Container

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.device.Container

All Implemented Interfaces:

ControlService, ErrorListener

Direct Known Subclasses:

Device

public abstract class Container
extends Control

The Container class implements the ControlService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, ControlService, ErrorListener, Hashtable, MessageHandler

Field Summary

protected long	broadcastCommandCount Define the broadcast command count (long) field.
protected long	broadcastMeasurementCount Define the broadcast measurement count (long) field.
protected long	broadcastSignalCount Define the broadcast signal count (long) field.
protected Measurement	capabilities Defines the Capabilities measurement.
protected static int	CHANNEL_CHANGED_EXCEPTION_RESOURCE Define the device changed exception resource (int) constant.
protected Measurement	configuration Defines the Configuration measurement.
protected static int	DEVICE_ACTIVE_STATE_RESOURCE Define the device active state resource (int) constant.
protected static int	DEVICE_ALIVE_STATE_RESOURCE Define the device alive state resource (int) constant.
protected static int	DEVICE_CHANGED_EXCEPTION_RESOURCE Define the device changed exception resource (int) constant.
protected static int	DEVICE_CONNECTED_STATE_RESOURCE Define the device connected state resource (int) constant.
protected static int	DEVICE_CREATED_STATE_RESOURCE Define the device created state resource (int) constant.
protected static int	DEVICE_DEAD_STATE_RESOURCE Define the device dead state resource (int) constant.
protected static int	DEVICE_STARTED_STATE_RESOURCE Define the device started state resource (int) constant.
protected static int[]	DEVICE_STATE_RESOURCE_TABLE Define the device state resource table (int[]) constant.
protected static int	EXCEPTION_NO_TRANSPORT_RESOURCE Define the exception no transport resource (int) constant.
protected static int	INITIALIZE_CONFIGURATION_EXCEPTION_RESOURCE Define the exception no transport resource (int) constant.
protected static int	INITIALIZE_CONFIGURATION_MISCOMPARE_RESOURCE Define the initialize configuration miscompare resource (int) constant.
protected static int	INITIALIZE_CONFIGURATION_RESOURCE Define the initialize configuration resource (int) constant.
protected static int	INITIALIZE_CONFIGURATION_SAME_RESOURCE Define the initialize configuration same resource (int) constant.
protected static int	INITIALIZE_READ_EXCEPTION_RESOURCE Define the initialize read exception resource (int) constant.
protected static int	INITIALIZE_WRITE_EXCEPTION_RESOURCE Define the initialize write exception resource (int) constant.
protected int	logLevel Define the log level (int) field.
protected static int	MESSAGE_RECEIVED_EXCEPTION_RESOURCE Define the message received exception resource (int) constant.
protected Measurement	metrics Define the metrics (Measurement) field.
static int	NOTIFICATION_PRIORITY_DEFAULT Define the notification priority default (int) constant.
protected int	notificationPriority Define the notification priority (int) field.
protected static int	PROCESSING_UNABLE_TO_KEEP_UP_EXCEPTION_RESOURCE Define the processing unable to keep up exception resource (int) constant.
protected static int	RUN_EXCEPTION_RESOURCE Define the run exception resource (int) constant.
protected static int	SEND_EXCEPTION_RESOURCE Define the send exception resource (int) constant.
protected java.lang.Object	stateChanged Define the state changed (Object) field.
protected Measurement	status Define the status (Measurement) field.
static char	TOPIC_DELIMITER Define the topic delimiter (char) constant.

Fields inherited from class org.eclipse.soda.dk.device.Control

EXCEPTION_READ_FAILED_RESOURCE, SET_VALUE_EXCEPTION_RESOURCE

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE, Unmodifiable

Constructor Summary

protected	Container() Constructs a Container object.
protected	Container(java.lang.String key) Constructs an instance of this class from the specified key parameter.

Method Summary

void	activate() Activate.
void	activate(ChannelService channel) Activate.
void	addData(java.lang.String topic, java.util.Dictionary data) Add data with the specified topic and data parameters.
protected void	addQualifiedKeys(java.lang.String id) Add qualified keys with the specified new id parameter.
protected boolean	attemptRecoveryFromError(int errorNumber, java.lang.Throwable error) Attempt recovery from error with the specified error number and error parameters and return the boolean result.
void	broadcast(java.lang.String topic, java.util.Dictionary data) Publish with the specified arg0 and arg1 parameters.
void	broadcastStatus() Broadcast status.
void	broadcastStatus(java.lang.Object timestamp, int newState, int oldState) Broadcast status with the specified timestamp, new state and old state parameters.
protected void	changeIds(java.lang.String oldId, java.lang.String newId) Change ids with the specified old id and new id parameters.
java.util.Map	collectMetrics() Collect metrics and return the Map result.
org.osgi.framework.Filter	createFilter(java.lang.String filterString) Create filter with the specified filter string parameter and return the Filter result.
void	deactivate() Deactivate.
void	deactivate(ChannelService channel) Deactivate.
java.util.Enumeration	elements() Perform the elementsData method and return the Enumeration result.
void	errorOccurred(java.lang.Object source, java.lang.Object timestamp, java.lang.Object data) The errorOccurred method is called when an error has occurred.
void	exit() Exit.
void	fireContainerChanged(java.lang.Object timestamp, int newState, int oldState) Fire container changed with the specified timestamp, new state and old state parameters.
void	fireErrorOccurred(java.lang.Object timestamp, java.lang.Object data) Fire error occurred with the specified timestamp and data parameters.
ControlService	get(java.lang.String key) Get with the specified key parameter and return the ControlService result.
long	getBroadcastCommandCount() Gets the broadcast command count (long) value.
long	getBroadcastMeasurementCount() Gets the broadcast measurement count (long) value.
long	getBroadcastSignalCount() Gets the broadcast signal count (long) value.
org.osgi.framework.BundleContext	getBundleContext() Gets the bundle context value.
MeasurementService	getCapabilities() Defines the Capabilities measurement.
CommandService	getCommand(java.lang.String key) Perform the getCommand method and return the CommandService result.
MeasurementService	getConfiguration() Defines the Configuration measurement.
java.util.Dictionary	getConfigurationInformation() Return the property table.
java.lang.Object	getConfigurationInformation(java.lang.String propertyName) Get configuration information with the specified property name parameter and return the Object result.
ConfigurationService	getConfigurationService() Gets the configuration service value.
protected int	getControlCapacity() Gets the control capacity (int) value.
java.util.Hashtable	getControls() Gets the Hashtable controls property value.
abstract java.lang.String	getDefaultKey() Method getDefaultKey.
short	getDefaultStyle() Gets the default style (short) value.
protected int	getErrorSeverity(int errorNumber, java.lang.Throwable error) Get error severity with the specified error number and error parameters and return the int result.
int	getInformation() Gets the int information property value.
java.lang.Object	getLogDetails4() Gets the log details4 (Object) value.
java.lang.Object	getLogDetails5() Gets the log details5 (Object) value.
java.lang.Object	getLogDetails6() Gets the log details6 (Object) value.
int	getLogLevel() Gets the log level (int) value.
MeasurementService	getMeasurement(java.lang.String key) Perform the getMeasurement method and return the MeasurementService result.
Measurement	getMetrics() Gets the metrics (Measurement) value.
NotificationController	getNotificationController() Gets the notification controller value.
int	getNotificationPriority() Gets the notification priority (int) value.
int	getNotificationPriorityDefault() Gets the notification priority default (int) value.
org.eclipse.soda.dk.notification.service.NotificationService	getNotificationService() Gets the notification service value.
java.lang.Number	getNumberValue(java.lang.Object data) Get number with the specified data parameter and return the Number result.
java.lang.String	getPrefix() Gets the prefix (String) value.
long	getReadTimeout() Gets the read timeout (long) value.
SignalService	getSignal(java.lang.String key) Perform the getSignal method and return the SignalService result.
int	getState() Gets the state (int) value.
MeasurementService	getStatus() Defines the Status measurement.
java.util.Dictionary	getStatusDictionary(int newState, int oldState) Get status dictionary with the specified new state and old state parameters and return the Dictionary result.
java.lang.String	getString(java.lang.String key, java.lang.String defaultString) Get string with the specified key and default string parameters and key (String) parameter.
int	getStyle() Gets the int style property value.
TransportService	getTransport() Gets the Transport transport property value.
java.lang.Object	handleMethodMetrics(int code, Measurement measurement, java.lang.Object data) Handle method metrics with the specified code, measurement and data parameters and return the Object result.
void	initializeMeasurements() Perform the initializeMeasurements action method.
void	initializeMeasurements(ChannelService channel) Perform the initializeMeasurements action method.
boolean	isInitializeMeasurements() Gets the boolean initializeMeasurements property value.
boolean	isRunning() Gets the running (boolean) value.
java.util.Enumeration	keys() Perform the keys method and return the Enumeration result.
protected void	load(ControlService control) Load with the specified control parameter.
void	notificationReceived(java.lang.String externalKey, java.util.Dictionary data) Notification received with the specified external key and data parameters.
java.lang.String	prependPrefix(java.lang.String topic) Prepend prefix with the specified topic parameter and return the String
java.lang.String	prependPrefix(java.lang.String topicPrefix, java.lang.String topic) Prepend prefix with the specified topic prefix and topic parameters and return the String result.
void	put(ControlService control) Put with the specified control parameter.
void	put(java.lang.String key, ControlService control) Perform the put action method.
void	putConfigurationInformation(java.lang.String propertyName, java.lang.Object value) Set the specified property value.
void	register(java.lang.String topic) Subscribe with the specified arg0 and arg1 parameters.
void	register(java.lang.String[] topics) Subscribe with the specified arg0 and arg1 parameters.
void	remove(java.lang.String key) Perform the remove action method.
void	removeListeners(DeviceService device) Remove listeners with the specified device parameter.
protected void	removeQualifiedKeys() Remove qualified keys.
void	send(ChannelService channel, MessageService message) Send with the specified channel and message parameters.
void	send(ChannelService channel, MessageService message, ResponseListener responseListener) Send with the specified channel, message and response listener parameters.
void	send(MessageService message) Send with the specified message parameter.
void	send(MessageService message, ResponseListener responseListener) Send with the specified message and response listener parameters.
void	setBroadcastCommandCount(long broadcastCommandCount) Sets the broadcast command count value.
void	setBroadcastMeasurementCount(long broadcastMeasurementCount) Sets the broadcast measurement count value.
void	setBroadcastSignalCount(long broadcastSignalCount) Sets the broadcast signal count value.
void	setBundleContext(org.osgi.framework.BundleContext bundleContext) Sets the bundle context value.
void	setConfigurationInformation(java.util.Dictionary configurationInformation) Sets the configuration information value.
protected void	setInformation(int information) Sets the information value.
void	setListenersNull() Set listeners null.
void	setLogLevel(int logLevel) Sets the log level value.
void	setMetrics(Measurement metrics) Sets the metrics value.
void	setNotificationController(NotificationController notificationController) Sets the notification controller value.
void	setNotificationPriority(int notificationPriority) Sets the notification priority value.
void	setNotificationService(org.eclipse.soda.dk.notification.service.NotificationService notificationService) Sets the notification service value.
void	setState(int state) Sets the state value.
protected void	setStateLocal(int state) Sets the state local value.
void	setStyle(short style) Sets the style value.
void	setTransport(TransportService transport) Sets the transport value.
void	setup() Method setup.
void	setupCustom() Setup custom.
void	setupNotification() Setup notification.
void	setupNotificationCustom() Setup notification custom.
void	start() Start.
void	startupCommands() Startup commands.
void	startupCommands(ChannelService channel) Startup commands.
void	stop() Stop.
java.lang.String	toString() Returns the string value.
void	toStringInfo(java.lang.StringBuffer buffer) To string info with the specified buffer parameter.
void	transportStartedWait() Active wait.
void	unregister(org.eclipse.soda.dk.notification.service.NotificationListener pubSubListener) Unregister with the specified pub sub listener parameter.
void	unsubscribe() Unsubscribe.
void	updateBroadcastCommandCount() Update broadcast command count.
void	updateBroadcastMeasurementCount() Update broadcast measurement count.
void	updateBroadcastSignalCount() Update broadcast signal count.
java.lang.String	validConfigurationId(java.lang.String name) Valid configuration id with the specified name parameter and return the String result.

Methods inherited from class org.eclipse.soda.dk.device.Control

equalsValue, findMethod, getCodeKey, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails7, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TOPIC_DELIMITER

public static final char TOPIC_DELIMITER

Define the topic delimiter (char) constant.

See Also:

Constant Field Values

NOTIFICATION_PRIORITY_DEFAULT

public static final int NOTIFICATION_PRIORITY_DEFAULT

Define the notification priority default (int) constant.

Since:

1.2

See Also:

Constant Field Values

INITIALIZE_CONFIGURATION_RESOURCE

protected static final int INITIALIZE_CONFIGURATION_RESOURCE

Define the initialize configuration resource (int) constant.

See Also:

Constant Field Values

DEVICE_STATE_RESOURCE_TABLE

protected static final int[] DEVICE_STATE_RESOURCE_TABLE

Define the device state resource table (int[]) constant.

INITIALIZE_CONFIGURATION_MISCOMPARE_RESOURCE

protected static final int INITIALIZE_CONFIGURATION_MISCOMPARE_RESOURCE

Define the initialize configuration miscompare resource (int) constant.

See Also:

Constant Field Values

DEVICE_CREATED_STATE_RESOURCE

protected static final int DEVICE_CREATED_STATE_RESOURCE

Define the device created state resource (int) constant.

See Also:

Constant Field Values

INITIALIZE_CONFIGURATION_SAME_RESOURCE

protected static final int INITIALIZE_CONFIGURATION_SAME_RESOURCE

Define the initialize configuration same resource (int) constant.

See Also:

Constant Field Values

DEVICE_CHANGED_EXCEPTION_RESOURCE

protected static final int DEVICE_CHANGED_EXCEPTION_RESOURCE

Define the device changed exception resource (int) constant.

See Also:

Constant Field Values

EXCEPTION_NO_TRANSPORT_RESOURCE

protected static final int EXCEPTION_NO_TRANSPORT_RESOURCE

Define the exception no transport resource (int) constant.

See Also:

Constant Field Values

DEVICE_DEAD_STATE_RESOURCE

protected static final int DEVICE_DEAD_STATE_RESOURCE

Define the device dead state resource (int) constant.

See Also:

Constant Field Values

CHANNEL_CHANGED_EXCEPTION_RESOURCE

protected static final int CHANNEL_CHANGED_EXCEPTION_RESOURCE

Define the device changed exception resource (int) constant.

Since:

1.2

See Also:

Constant Field Values

RUN_EXCEPTION_RESOURCE

protected static final int RUN_EXCEPTION_RESOURCE

Define the run exception resource (int) constant.

See Also:

Constant Field Values

DEVICE_ALIVE_STATE_RESOURCE

protected static final int DEVICE_ALIVE_STATE_RESOURCE

Define the device alive state resource (int) constant.

See Also:

Constant Field Values

INITIALIZE_READ_EXCEPTION_RESOURCE

protected static final int INITIALIZE_READ_EXCEPTION_RESOURCE

Define the initialize read exception resource (int) constant.

See Also:

Constant Field Values

DEVICE_CONNECTED_STATE_RESOURCE

protected static final int DEVICE_CONNECTED_STATE_RESOURCE

Define the device connected state resource (int) constant.

See Also:

Constant Field Values

INITIALIZE_WRITE_EXCEPTION_RESOURCE

protected static final int INITIALIZE_WRITE_EXCEPTION_RESOURCE

Define the initialize write exception resource (int) constant.

See Also:

Constant Field Values

DEVICE_ACTIVE_STATE_RESOURCE

protected static final int DEVICE_ACTIVE_STATE_RESOURCE

Define the device active state resource (int) constant.

See Also:

Constant Field Values

SEND_EXCEPTION_RESOURCE

protected static final int SEND_EXCEPTION_RESOURCE

Define the send exception resource (int) constant.

See Also:

Constant Field Values

DEVICE_STARTED_STATE_RESOURCE

protected static final int DEVICE_STARTED_STATE_RESOURCE

Define the device started state resource (int) constant.

See Also:

Constant Field Values

PROCESSING_UNABLE_TO_KEEP_UP_EXCEPTION_RESOURCE

protected static final int PROCESSING_UNABLE_TO_KEEP_UP_EXCEPTION_RESOURCE

Define the processing unable to keep up exception resource (int) constant.

See Also:

Constant Field Values

MESSAGE_RECEIVED_EXCEPTION_RESOURCE

protected static final int MESSAGE_RECEIVED_EXCEPTION_RESOURCE

Define the message received exception resource (int) constant.

See Also:

Constant Field Values

INITIALIZE_CONFIGURATION_EXCEPTION_RESOURCE

protected static final int INITIALIZE_CONFIGURATION_EXCEPTION_RESOURCE

Define the exception no transport resource (int) constant.

See Also:

Constant Field Values

stateChanged

protected final java.lang.Object stateChanged

Define the state changed (Object) field.

Since:

1.2

status

protected Measurement status

Define the status (Measurement) field.

configuration

protected Measurement configuration

Defines the Configuration measurement.

capabilities

protected Measurement capabilities

Defines the Capabilities measurement.

metrics

protected Measurement metrics

Define the metrics (Measurement) field.

broadcastCommandCount

protected long broadcastCommandCount

Define the broadcast command count (long) field.

broadcastMeasurementCount

protected long broadcastMeasurementCount

Define the broadcast measurement count (long) field.

broadcastSignalCount

protected long broadcastSignalCount

Define the broadcast signal count (long) field.

logLevel

protected int logLevel

Define the log level (int) field.

notificationPriority

protected int notificationPriority

Define the notification priority (int) field.

Since:

1.2

Constructor Detail

Container

protected Container()

Constructs a Container object.

See Also:

Container(String)

Container

protected Container(java.lang.String key)

Constructs an instance of this class from the specified key parameter. The key (String) parameter. The key (String)

Parameters:

key - The key (String) parameter.

See Also:

Container()

Method Detail

activate

public void activate()

Activate.

See Also:

activate(ChannelService)

activate

public void activate(ChannelService channel)

Activate.

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

activate()

addData

public void addData(java.lang.String topic,
                    java.util.Dictionary data)

Add data with the specified topic and data parameters.

Parameters:

topic - The topic (String) parameter.

data - The data (Dictionary) parameter.

addQualifiedKeys

protected void addQualifiedKeys(java.lang.String id)

Add qualified keys with the specified new id parameter. The new id (String) parameter. The id (String) parameter. The id (String)

Parameters:

id - The ID (String) parameter.

See Also:

removeQualifiedKeys()

attemptRecoveryFromError

protected boolean attemptRecoveryFromError(int errorNumber,
                                           java.lang.Throwable error)

Attempt recovery from error with the specified error number and error parameters and return the boolean result.

Overrides:

attemptRecoveryFromError in class Control

Parameters:

errorNumber - The error number (int) parameter.

error - The error (Throwable) parameter.

Returns:

Results of the attempt recovery from error (boolean) value.

broadcast

public void broadcast(java.lang.String topic,
                      java.util.Dictionary data)

Publish with the specified arg0 and arg1 parameters. The arg0 (String) parameter. The arg1 (Object) parameter. The topic (String) parameter. The data (Dictionary) parameter. The topic ( String)

Parameters:

topic - The topic (String) parameter.

data - The data (Dictionary) parameter.

broadcastStatus

public void broadcastStatus()

Broadcast status.

See Also:

broadcastStatus(Object,int,int), getStatus()

broadcastStatus

public void broadcastStatus(java.lang.Object timestamp,
                            int newState,
                            int oldState)

Broadcast status with the specified timestamp, new state and old state parameters.

Parameters:

timestamp - The time stamp (Object) parameter.

newState - The new state (int) parameter.

oldState - The old state (int) parameter.

See Also:

broadcastStatus(), getStatus()

changeIds

protected void changeIds(java.lang.String oldId,
                         java.lang.String newId)

Change ids with the specified old id and new id parameters. The old id (String) parameter. The new id (String) parameter. The old id (String) parameter. The new id (String) parameter. The old id ( String)

Parameters:

oldId - The old ID (String) parameter.

newId - The new ID (String) parameter.

collectMetrics

public java.util.Map collectMetrics()

Collect metrics and return the Map result.

Returns:

Results of the collect metrics (Map) value.

See Also:

getMetrics(), handleMethodMetrics(int,Measurement,Object), setMetrics(Measurement)

createFilter

public org.osgi.framework.Filter createFilter(java.lang.String filterString)
                                       throws org.osgi.framework.InvalidSyntaxException

Create filter with the specified filter string parameter and return the Filter result.

Parameters:

filterString - The filter string (String) parameter.

Returns:

Results of the create filter (Filter) value.

Throws:

org.osgi.framework.InvalidSyntaxException - Invalid Syntax Exception.

deactivate

public void deactivate()

Deactivate.

See Also:

deactivate(ChannelService)

deactivate

public void deactivate(ChannelService channel)

Deactivate.

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

deactivate()

elements

public java.util.Enumeration elements()

Perform the elementsData method and return the Enumeration result.

Returns:

Results of the elementsData (Enumeration) value.

errorOccurred

public void errorOccurred(java.lang.Object source,
                          java.lang.Object timestamp,
                          java.lang.Object data)

The errorOccurred method is called when an error has occurred. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (e.g. calling read on a measurement).
• Handle this call quickly and return.

The source object that detected the error. The time at which the error was detected. Contains any data about the error. The source (Object) parameter. The timestamp (Object) parameter. The data (Object) parameter. The source (Object) parameter. The timestamp (Object)

Specified by:

errorOccurred in interface ErrorListener

Overrides:

errorOccurred in class Control

Parameters:

source - The source (Object) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireErrorOccurred(Object,Object)

exit

public void exit()

Exit.

fireContainerChanged

public void fireContainerChanged(java.lang.Object timestamp,
                                 int newState,
                                 int oldState)

Fire container changed with the specified timestamp, new state and old state parameters.

Parameters:

timestamp - The time stamp (Object) parameter.

newState - The new state (int) parameter.

oldState - The old state (int) parameter.

fireErrorOccurred

public void fireErrorOccurred(java.lang.Object timestamp,
                              java.lang.Object data)

Fire error occurred with the specified timestamp and data parameters.

Parameters:

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

get

public ControlService get(java.lang.String key)

Get with the specified key parameter and return the ControlService result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get (ControlService) value. The

getBroadcastCommandCount

public long getBroadcastCommandCount()

Gets the broadcast command count (long) value.

Returns:

The broadcast command count (long) value.

See Also:

setBroadcastCommandCount(long), updateBroadcastCommandCount()

getBroadcastMeasurementCount

public long getBroadcastMeasurementCount()

Gets the broadcast measurement count (long) value.

Returns:

The broadcast measurement count (long) value.

See Also:

setBroadcastMeasurementCount(long), updateBroadcastMeasurementCount()

getBroadcastSignalCount

public long getBroadcastSignalCount()

Gets the broadcast signal count (long) value.

Returns:

The broadcast signal count (long) value.

See Also:

setBroadcastSignalCount(long), updateBroadcastSignalCount()

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Gets the bundle context value.

Returns:

The bundle context (BundleContext) value.

See Also:

setBundleContext(BundleContext)

getCapabilities

public MeasurementService getCapabilities()

Defines the Capabilities measurement.

Returns:

Results of the get capabilities (MeasurementService)

getCommand

public CommandService getCommand(java.lang.String key)
                          throws java.lang.ClassCastException

Perform the getCommand method and return the CommandService result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get command (CommandService)

Throws:

java.lang.ClassCastException - Class Cast Exception.

getConfiguration

public MeasurementService getConfiguration()

Defines the Configuration measurement. value.

Returns:

Results of the get configuration (MeasurementService)

getConfigurationInformation

public java.util.Dictionary getConfigurationInformation()

Return the property table.

Returns:

Results of the get configuration information (Dictionary)

See Also:

getConfigurationInformation(String), putConfigurationInformation(String,Object), setConfigurationInformation(Dictionary)

getConfigurationInformation

public java.lang.Object getConfigurationInformation(java.lang.String propertyName)

Get configuration information with the specified property name parameter and return the Object result.

Parameters:

propertyName - The property name (String) parameter.

Returns:

Results of the get configuration information (Object)

See Also:

getConfigurationInformation(), putConfigurationInformation(String,Object), setConfigurationInformation(Dictionary)

getConfigurationService

public ConfigurationService getConfigurationService()

Gets the configuration service value.

Overrides:

getConfigurationService in class EscObject

Returns:

The configuration service (ConfigurationService)

getControlCapacity

protected int getControlCapacity()

Gets the control capacity (int) value.

Returns:

int The control capacity.

getControls

public java.util.Hashtable getControls()

Gets the Hashtable controls property value.

Returns:

Results of the get controls (Hashtable) value.

getDefaultKey

public abstract java.lang.String getDefaultKey()

Method getDefaultKey.

Returns:

Results of the get default key (String) value.

getDefaultStyle

public short getDefaultStyle()

Gets the default style (short) value.

Returns:

The default style (short) value.

getErrorSeverity

protected int getErrorSeverity(int errorNumber,
                               java.lang.Throwable error)

Get error severity with the specified error number and error parameters and return the int result.

Overrides:

getErrorSeverity in class Control

Parameters:

errorNumber - The error number (int) parameter.

error - The error (Throwable) parameter.

Returns:

Results of the get error severity (int) value.

See Also:

EscObject.getErrorSeverity(int,Throwable)

getInformation

public int getInformation()

Gets the int information property value.

Returns:

Results of the get information (int) value.

See Also:

getConfigurationInformation(), getConfigurationInformation(String), putConfigurationInformation(String,Object), setConfigurationInformation(Dictionary), setInformation(int)

getLogDetails4

public java.lang.Object getLogDetails4()

Gets the log details4 (Object) value.

Overrides:

getLogDetails4 in class EscObject

Returns:

The log details4 (Object) value.

getLogDetails5

public java.lang.Object getLogDetails5()

Gets the log details5 (Object) value.

Overrides:

getLogDetails5 in class EscObject

Returns:

The log details5 (Object) value.

getLogDetails6

public java.lang.Object getLogDetails6()

Gets the log details6 (Object) value.

Overrides:

getLogDetails6 in class EscObject

Returns:

The log details6 (Object) value.

getLogLevel

public int getLogLevel()

Gets the log level (int) value.

Overrides:

getLogLevel in class EscObject

Returns:

The log level (int) value.

See Also:

setLogLevel(int)

getMeasurement

public MeasurementService getMeasurement(java.lang.String key)
                                  throws java.lang.ClassCastException

Perform the getMeasurement method and return the MeasurementService result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get measurement (MeasurementService)

Throws:

java.lang.ClassCastException - Class Cast Exception.

getMetrics

public Measurement getMetrics()

Gets the metrics (Measurement) value.

Returns:

The metrics (Measurement) value.

See Also:

collectMetrics(), handleMethodMetrics(int,Measurement,Object), setMetrics(Measurement)

getNotificationController

public NotificationController getNotificationController()

Gets the notification controller value.

Returns:

The notification controller (NotificationController)

See Also:

setNotificationController(NotificationController)

getNotificationPriority

public int getNotificationPriority()

Gets the notification priority (int) value.

Returns:

The notification priority (int) value.

Since:

1.2

See Also:

setNotificationPriority(int)

getNotificationPriorityDefault

public int getNotificationPriorityDefault()

Gets the notification priority default (int) value.

Returns:

The notification priority default (int) value.

Since:

1.2

getNotificationService

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

Gets the notification service value.

Returns:

The notification service (NotificationService)

See Also:

setNotificationService(NotificationService)

getNumberValue

public java.lang.Number getNumberValue(java.lang.Object data)

Get number with the specified data parameter and return the Number result.

Parameters:

data - The data (Object) parameter.

Returns:

Results of the get number (Number) value.

getPrefix

public java.lang.String getPrefix()

Gets the prefix (String) value.

Returns:

The prefix (String) value.

See Also:

prependPrefix(String), prependPrefix(String,String)

getReadTimeout

public long getReadTimeout()

Gets the read timeout (long) value.

Returns:

The read timeout (long) value.

getSignal

public SignalService getSignal(java.lang.String key)
                        throws java.lang.ClassCastException

Perform the getSignal method and return the SignalService result. String href="java.lang.ClassCastException.html">ClassCastException Thrown if the ClassCastException exception condition occurs. The key ( String) parameter. Class Cast Exception. The key (String) parameter. Class Cast Exception. Class Cast Exception.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get signal (SignalService) value.

Throws:

java.lang.ClassCastException - Class Cast Exception.

getState

public int getState()

Gets the state (int) value.

Returns:

The state (int) value.

See Also:

setState(int)

getStatus

public MeasurementService getStatus()

Defines the Status measurement. value.

Returns:

Results of the get status (MeasurementService)

See Also:

broadcastStatus(), broadcastStatus(Object,int,int)

getStatusDictionary

public java.util.Dictionary getStatusDictionary(int newState,
                                                int oldState)

Get status dictionary with the specified new state and old state parameters and return the Dictionary result. The new state (int) value. The new state (int) parameter. The old

Parameters:

newState - The new state (int) parameter.

oldState - The old state (int) parameter.

Returns:

Results of the get status dictionary (Dictionary)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultString)

Get string with the specified key and default string parameters and key (String) parameter. The default string (String) parameter. The key (String) parameter. The

Overrides:

getString in class EscObject

Parameters:

key - The key (String) parameter.

defaultString - The default string (String) parameter.

Returns:

Results of the get string (String) value. The

See Also:

toString()

getStyle

public int getStyle()

Gets the int style property value.

Returns:

Results of the get style (int) value.

See Also:

getDefaultStyle(), setStyle(short)

getTransport

public TransportService getTransport()

Gets the Transport transport property value.

Returns:

Results of the get transport (TransportService)

See Also:

setTransport(TransportService)

handleMethodMetrics

public java.lang.Object handleMethodMetrics(int code,
                                            Measurement measurement,
                                            java.lang.Object data)

Handle method metrics with the specified code, measurement and data parameters and return the Object result.

Parameters:

code - The code (int) parameter.

measurement - The measurement (Measurement) parameter.

data - The data (Object) parameter.

Returns:

Results of the handle method metrics (Object) value.

initializeMeasurements

public void initializeMeasurements()

Perform the initializeMeasurements action method.

See Also:

initializeMeasurements(ChannelService), isInitializeMeasurements()

initializeMeasurements

public void initializeMeasurements(ChannelService channel)

Perform the initializeMeasurements action method.

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

initializeMeasurements(), isInitializeMeasurements()

isInitializeMeasurements

public boolean isInitializeMeasurements()

Gets the boolean initializeMeasurements property value.

Returns:

Results of the is initialize measurements (boolean)

isRunning

public boolean isRunning()

Gets the running (boolean) value.

Returns:

The running (boolean) value.

keys

public java.util.Enumeration keys()

Perform the keys method and return the Enumeration result.

Returns:

Results of the keys (Enumeration) value.

load

protected void load(ControlService control)

Load with the specified control parameter.

Parameters:

control - The control (ControlService) parameter.

notificationReceived

public void notificationReceived(java.lang.String externalKey,
                                 java.util.Dictionary data)

Notification received with the specified external key and data parameters. The external key (String) parameter. The data (Dictionary) parameter. The external key (String)

Parameters:

externalKey - The external key (String) parameter.

data - The data (Dictionary) parameter.

prependPrefix

public java.lang.String prependPrefix(java.lang.String topic)

Prepend prefix with the specified topic parameter and return the String

Parameters:

topic - The topic (String) parameter.

Returns:

Results of the prepend prefix (String) value.

See Also:

getPrefix(), prependPrefix(String,String)

prependPrefix

public java.lang.String prependPrefix(java.lang.String topicPrefix,
                                      java.lang.String topic)

Prepend prefix with the specified topic prefix and topic parameters and return the String result.

Parameters:

topicPrefix - The topic prefix (String) parameter.

topic - The topic (String) parameter.

Returns:

Results of the prepend prefix (String) value.

See Also:

getPrefix(), prependPrefix(String)

put

public void put(ControlService control)

Put with the specified control parameter.

Parameters:

control - The control (ControlService) parameter.

See Also:

put(String,ControlService)

put

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

Perform the put action method.

Parameters:

key - The key (String) parameter.

control - The control (ControlService) parameter.

See Also:

put(ControlService)

putConfigurationInformation

public void putConfigurationInformation(java.lang.String propertyName,
                                        java.lang.Object value)

Set the specified property value.

Parameters:

propertyName - The property name (String) parameter.

value - The value (Object) parameter.

See Also:

getConfigurationInformation(), getConfigurationInformation(String), setConfigurationInformation(Dictionary)

register

public void register(java.lang.String topic)

Subscribe with the specified arg0 and arg1 parameters.

Parameters:

topic - The topic (String) parameter.

See Also:

register(String[])

register

public void register(java.lang.String[] topics)

Subscribe with the specified arg0 and arg1 parameters. The arg0 (String[]) The topics (String[]) parameter. The pub sub listener (NotificationListener)

Parameters:

topics - The topics (String[]) parameter.

See Also:

register(String)

remove

public void remove(java.lang.String key)

Perform the remove action method. java.lang.String The key (String)

Parameters:

key - The key (String) parameter.

removeListeners

public void removeListeners(DeviceService device)

Remove listeners with the specified device parameter.

Parameters:

device - The device (DeviceService) parameter.

removeQualifiedKeys

protected void removeQualifiedKeys()

Remove qualified keys.

See Also:

addQualifiedKeys(String)

send

public void send(ChannelService channel,
                 MessageService message)

Send with the specified channel and message parameters.

Parameters:

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

Since:

1.2

See Also:

send(ChannelService,MessageService,ResponseListener), send(MessageService), send(MessageService,ResponseListener)

send

public void send(ChannelService channel,
                 MessageService message,
                 ResponseListener responseListener)

Send with the specified channel, message and response listener parameters.

Parameters:

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

responseListener - The response listener (ResponseListener) parameter.

Since:

1.2

See Also:

send(ChannelService,MessageService), send(MessageService), send(MessageService,ResponseListener)

send

public void send(MessageService message)

Send with the specified message parameter.

Parameters:

message - The message (MessageService) parameter.

See Also:

send(ChannelService,MessageService), send(ChannelService,MessageService,ResponseListener), send(MessageService,ResponseListener)

send

public void send(MessageService message,
                 ResponseListener responseListener)

Send with the specified message and response listener parameters.

Parameters:

message - The message (MessageService) parameter.

responseListener - The response listener (ResponseListener) parameter.

Since:

1.2

See Also:

send(ChannelService,MessageService), send(ChannelService,MessageService,ResponseListener), send(MessageService)

setBroadcastCommandCount

public void setBroadcastCommandCount(long broadcastCommandCount)

Sets the broadcast command count value.

Parameters:

broadcastCommandCount - The broadcast command count (long) parameter.

See Also:

getBroadcastCommandCount(), updateBroadcastCommandCount()

setBroadcastMeasurementCount

public void setBroadcastMeasurementCount(long broadcastMeasurementCount)

Sets the broadcast measurement count value.

Parameters:

broadcastMeasurementCount - The broadcast measurement count (long) parameter.

See Also:

getBroadcastMeasurementCount(), updateBroadcastMeasurementCount()

setBroadcastSignalCount

public void setBroadcastSignalCount(long broadcastSignalCount)

Sets the broadcast signal count value.

Parameters:

broadcastSignalCount - The broadcast signal count (long) parameter.

See Also:

getBroadcastSignalCount(), updateBroadcastSignalCount()

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext bundleContext)

Sets the bundle context value.

Parameters:

bundleContext - The bundle context (BundleContext) parameter.

See Also:

getBundleContext()

setConfigurationInformation

public void setConfigurationInformation(java.util.Dictionary configurationInformation)

Sets the configuration information value.

Parameters:

configurationInformation - The configuration information (Dictionary) parameter.

See Also:

getConfigurationInformation(), getConfigurationInformation(String), putConfigurationInformation(String,Object)

setInformation

protected void setInformation(int information)

Sets the information value.

Parameters:

information - The information (int) parameter.

See Also:

getConfigurationInformation(), getConfigurationInformation(String), getInformation(), putConfigurationInformation(String,Object), setConfigurationInformation(Dictionary)

setListenersNull

public void setListenersNull()

Set listeners null.

setLogLevel

public void setLogLevel(int logLevel)

Sets the log level value.

Parameters:

logLevel - The log level (int) parameter.

See Also:

getLogLevel()

setMetrics

public void setMetrics(Measurement metrics)

Sets the metrics value.

Parameters:

metrics - The metrics (Measurement) parameter.

See Also:

collectMetrics(), getMetrics(), handleMethodMetrics(int,Measurement,Object)

setNotificationController

public void setNotificationController(NotificationController notificationController)

Sets the notification controller value.

Parameters:

notificationController - The notification controller (NotificationController) parameter.

See Also:

getNotificationController()

setNotificationPriority

public void setNotificationPriority(int notificationPriority)

Sets the notification priority value.

Parameters:

notificationPriority - The notification priority (int) parameter.

Since:

1.2

See Also:

getNotificationPriority()

setNotificationService

public 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()

setState

public void setState(int state)

Sets the state value.

Parameters:

state - The state (int) parameter.

See Also:

getState()

setStateLocal

protected final void setStateLocal(int state)

Sets the state local value.

Parameters:

state - The state (int) parameter.

setStyle

public void setStyle(short style)

Sets the style value.

Parameters:

style - The style (short) parameter.

See Also:

getDefaultStyle(), getStyle()

setTransport

public void setTransport(TransportService transport)

Sets the transport value.

Parameters:

transport - The transport (TransportService) parameter.

See Also:

getTransport()

setup

public void setup()

Method setup.

setupCustom

public void setupCustom()

Setup custom.

See Also:

setupNotificationCustom()

setupNotification

public void setupNotification()

Setup notification.

setupNotificationCustom

public void setupNotificationCustom()

Setup notification custom.

start

public void start()

Start.

startupCommands

public void startupCommands()

Startup commands.

See Also:

startupCommands(ChannelService)

startupCommands

public void startupCommands(ChannelService channel)

Startup commands.

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

startupCommands()

stop

public void stop()

Stop.

toString

public java.lang.String toString()

Returns the string value.

Overrides:

toString in class Control

Returns:

The string (String) value.

See Also:

getString(String,String)

toStringInfo

public void toStringInfo(java.lang.StringBuffer buffer)

To string info with the specified buffer parameter. The buffer (StringBuffer) parameter. The buffer (StringBuffer) parameter. The

Overrides:

toStringInfo in class EscObject

Parameters:

buffer - The buffer (StringBuffer) parameter.

transportStartedWait

public void transportStartedWait()

Active wait.

unregister

public void unregister(org.eclipse.soda.dk.notification.service.NotificationListener pubSubListener)

Unregister with the specified pub sub listener parameter.

Parameters:

pubSubListener - The pub sub listener (NotificationListener) parameter.

unsubscribe

public void unsubscribe()

Unsubscribe.

updateBroadcastCommandCount

public void updateBroadcastCommandCount()

Update broadcast command count.

See Also:

getBroadcastCommandCount(), setBroadcastCommandCount(long)

updateBroadcastMeasurementCount

public void updateBroadcastMeasurementCount()

Update broadcast measurement count.

See Also:

getBroadcastMeasurementCount(), setBroadcastMeasurementCount(long)

updateBroadcastSignalCount

public void updateBroadcastSignalCount()

Update broadcast signal count.

See Also:

getBroadcastSignalCount(), setBroadcastSignalCount(long)

validConfigurationId

public java.lang.String validConfigurationId(java.lang.String name)

Valid configuration id with the specified name parameter and return the String result.

Parameters:

name - The name (String) parameter.

Returns:

Results of the valid configuration id (String) value.