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.

Version:

1.0.0

See Also:

Control, ControlService, ErrorListener, Hashtable, MessageHandler

Field Summary

protected Measurement	capabilities Defines the Capabilities measurement.
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 static int	MESSAGE_RECEIVED_EXCEPTION_RESOURCE Define the message received exception resource (int) constant.
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	stateChanaged Define the state chanaged (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, SETVALUEEXCEPTION_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, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

Constructor Summary

Container()
Constructs a Container object.

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

Method Summary

void	activate() Activate.
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) Returns true if attempt recovery from error.
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 source, 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.
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.
java.util.Enumeration	elements() Perform the elements 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) This method will be called when the state of the DeviceService changes to notify listeners of the changes.
void	fireErrorOccurred(java.lang.Object timestamp, java.lang.Object data) Perform the fireErrorOccurred action method.
ControlService	get(java.lang.String key) Perform the get method and return the ControlService result.
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) Return the property value.
ConfigurationService	getConfigurationService() Gets the configuration service value.
protected int	getControlCapacity() Gets the control capacity.
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) Return the error severity of the specified error number.
java.lang.String	getId() Gets the id (String) value.
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.
MeasurementService	getMeasurement(java.lang.String key) Perform the getMeasurement method and return the MeasurementService result.
NotificationController	getNotificationController() Gets the notification controller value.
NotificationService	getNotificationService() Gets the notification service value.
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 return the String result.
int	getStyle() Gets the int style property value.
TransportService	getTransport() Gets the Transport transport property value.
void	initializeMeasurements() 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) Perform the load action method.
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 result.
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(MessageService message) Perform the send action method.
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 property.
void	setListenersNull() Set listeners null.
void	setNotificationController(NotificationController notificationController) Sets the notification controller value.
void	setNotificationService(NotificationService notificationService) Sets the notification service value.
void	setState(int state) Set the state of the Device.
void	setStyle(short style) Sets the style property.
void	setTransport(TransportService transport) Sets the transport property.
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	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(NotificationListener pubSubListener) Unsubscribe with the specified arg0 parameter.
void	unsubscribe() Unsubscribe.

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

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

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

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails7, getLogService, getLong, getObject, getOutputName, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, 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

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

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

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

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

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

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

DEVICE_STATE_RESOURCE_TABLE

protected static final int[] DEVICE_STATE_RESOURCE_TABLE

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

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

RUN_EXCEPTION_RESOURCE

protected static final int RUN_EXCEPTION_RESOURCE

Define the run exception 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

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

SEND_EXCEPTION_RESOURCE

protected static final int SEND_EXCEPTION_RESOURCE

Define the send exception 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

INITIALIZE_CONFIGURATION_RESOURCE

protected static final int INITIALIZE_CONFIGURATION_RESOURCE

Define the initialize configuration resource (int) constant.

See Also:

Constant Field Values

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

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

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

stateChanaged

protected final java.lang.Object stateChanaged

Define the state chanaged (Object) field.

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.

Constructor Detail

Container

public Container()

Constructs a Container object.

See Also:

Container(String)

Container

public Container(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

Container()

Method Detail

activate

public void activate()

Activate.

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) parameter. The id (String) parameter.

Parameters:

id - The id (String) parameter.

See Also:

removeQualifiedKeys()

attemptRecoveryFromError

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

Description copied from class: EscObject

Returns true if attempt recovery from error.

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. The error number (int) parameter. The error (Throwable) parameter. The error number (int) parameter. The error (Throwable) parameter.

See Also:

The error number (int) parameter. The error (Throwable) parameter.

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) parameter. The data (Dictionary) parameter.

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 source, timestamp, new state and old state parameters. The source (DeviceService) parameter. The timestamp (Object) parameter. The new state (int) parameter. The old state (int) parameter. The timestamp (Object) parameter. The new state (int) parameter. The old state (int) parameter.

Parameters:

timestamp - The timestamp (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) parameter. The new id (String) parameter.

Parameters:

oldId - The old id (String) parameter.

newId - The new id (String) parameter.

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. The filter string (String) parameter.

Parameters:

filterString - The filter string (String) parameter.

Returns:

Results of the create filter (Filter) value. Invalid Syntax Exception. The filter string (String) parameter. Invalid Syntax Exception.

Throws:

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

deactivate

public void deactivate()

Deactivate.

elements

public java.util.Enumeration elements()

Perform the elements method and return the Enumeration result.

Returns:

Results of the elements (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 (eg calling read on a measuremnt).
• 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) parameter. The data (Object) parameter.

Specified by:

errorOccurred in interface ErrorListener

Overrides:

errorOccurred in class Control

Parameters:

source - The source (Object) parameter.

timestamp - The timestamp (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)

This method will be called when the state of the DeviceService changes to notify listeners of the changes. org.eclipse.soda.dk.device.service.DeviceService java.lang.Object The new state of the TransportService. The old state of the TransportService. The source (ContainerService) parameter. The timestamp (Object) parameter. The new state (int) parameter. The old state (int) parameter. The timestamp (Object) parameter. The new state (int) parameter. The old state (int) parameter.

Parameters:

timestamp - The timestamp (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)

Perform the fireErrorOccurred action method. java.lang.Object java.lang.Object The timestamp (Object) parameter. The data (Object) parameter. The timestamp (Object) parameter. The data (Object) parameter.

Parameters:

timestamp - The timestamp (Object) parameter.

data - The data (Object) parameter.

get

public ControlService get(java.lang.String key)

Perform the get method and return the ControlService result. java.lang.String

Parameters:

key - The key (String) parameter.

Returns:

Results of the get (ControlService) value. The key (String) parameter. The key (String) parameter.

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) value.

getCommand

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

Perform the getCommand method and return the CommandService result. String href="java.lang.ClassCastException.html">ClassCastException Thrown if the ClassCastException exception condition occurs.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get command (CommandService) value. The key (String) parameter. Class Cast Exception. The key (String) parameter. Class Cast Exception.

Throws:

java.lang.ClassCastException - Class Cast Exception.

getConfiguration

public MeasurementService getConfiguration()

Defines the Configuration measurement.

Returns:

Results of the get configuration (MeasurementService) value.

getConfigurationInformation

public java.util.Dictionary getConfigurationInformation()

Return the property table.

Returns:

Results of the get configuration information (Dictionary) value.

See Also:

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

getConfigurationInformation

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

Return the property value. The property name (String) parameter.

Parameters:

propertyName - The property name (String) parameter.

Returns:

Results of the get configuration information (Object) value. The property name (String) parameter. The property name (String) parameter.

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) value.

getControlCapacity

protected int getControlCapacity()

Gets the control capacity.

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)

Description copied from class: EscObject

Return the error severity of the specified error number.

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. The error number (int) parameter. The error (Throwable) parameter. The error number (int) parameter. The error (Throwable) parameter.

See Also:

The error number (int) parameter. The error (Throwable) parameter.

getId

public java.lang.String getId()

Gets the id (String) value.

Returns:

The id (String) value.

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.

getMeasurement

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

Perform the getMeasurement method and return the MeasurementService result. String href="java.lang.ClassCastException.html">ClassCastException Thrown if the ClassCastException exception condition occurs.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get measurement (MeasurementService) value. The key (String) parameter. Class Cast Exception. The key (String) parameter. Class Cast Exception.

Throws:

java.lang.ClassCastException - Class Cast Exception.

getNotificationController

public NotificationController getNotificationController()

Gets the notification controller value.

Returns:

The notification controller (NotificationController) value.

See Also:

setNotificationController(NotificationController)

getNotificationService

public NotificationService getNotificationService()

Gets the notification service value.

Returns:

The notification service (NotificationService) value.

See Also:

setNotificationService(NotificationService)

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.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get signal (SignalService) value. The key (String) parameter. Class Cast Exception. The key (String) parameter. Class Cast Exception.

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.

Returns:

Results of the get status (MeasurementService) value.

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) parameter. The old state (int) parameter.

Parameters:

newState - The new state (int) parameter.

oldState - The old state (int) parameter.

Returns:

Results of the get status dictionary (Dictionary) value. The new state (int) parameter. The old state (int) parameter.

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 return the String result. The key (String) parameter. The default string (String) parameter.

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 key (String) parameter. The default string (String) parameter. The key (String) parameter. The default string (String) parameter.

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) value.

See Also:

DeviceService.getTransport(), setTransport(TransportService)

initializeMeasurements

public void initializeMeasurements()

Perform the initializeMeasurements action method.

See Also:

isInitializeMeasurements()

isInitializeMeasurements

public boolean isInitializeMeasurements()

Gets the boolean initializeMeasurements property value.

Returns:

Results of the is initialize measurements (boolean) value.

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)

Perform the load action method. org.eclipse.soda.dk.device.service.ControlService The control (ControlService) parameter. The control (ControlService) 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) parameter. The data (Dictionary) parameter.

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 result. The topic (String) parameter.

Parameters:

topic - The topic (String) parameter.

Returns:

Results of the prepend prefix (String) value. The topic (String) parameter.

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. The topic prefix (String) parameter. The topic (String) parameter.

Parameters:

topicPrefix - The topic prefix (String) parameter.

topic - The topic (String) parameter.

Returns:

Results of the prepend prefix (String) value. The topic prefix (String) parameter. The topic (String) parameter.

See Also:

getPrefix(), prependPrefix(String)

put

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

Perform the put action method. java.lang.String The control (ControlService) parameter. The key (String) parameter. The control (ControlService) parameter. The key (String) parameter. The control (ControlService) parameter.

Parameters:

key - The key (String) parameter.

control - The control (ControlService) parameter.

See Also:

put(ControlService)

put

public void put(ControlService control)

Put with the specified control parameter. The control (ControlService) parameter. The control (ControlService) parameter. The control (ControlService) parameter.

Parameters:

control - The control (ControlService) parameter.

See Also:

put(String,ControlService)

putConfigurationInformation

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

Set the specified property value. The property name (String) parameter. The value (Object) parameter. The property name (String) parameter. The value (Object) parameter. The property name (String) parameter. The value (Object) parameter.

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. The arg0 (String) parameter. The arg1 (NotificationListener) parameter. The topics (String) parameter. The pub sub listener (NotificationListener) parameter. The topic (String) parameter.

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[]) parameter. The arg1 (NotificationListener) parameter. The topics (String[]) parameter. The pub sub listener (NotificationListener) parameter. The topics (String[]) parameter.

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) parameter. The key (String) parameter.

Parameters:

key - The key (String) parameter.

removeListeners

public void removeListeners(DeviceService device)

Remove listeners with the specified device parameter. The device (DeviceService) parameter.

Parameters:

device - The device (DeviceService) parameter.

removeQualifiedKeys

protected void removeQualifiedKeys()

Remove qualified keys.

See Also:

addQualifiedKeys(String)

send

public void send(MessageService message)

Perform the send action method. org.eclipse.soda.dk.message.service.MessageService The message (MessageService) parameter. The message (MessageService) parameter.

Parameters:

message - The message (MessageService) parameter.

setBundleContext

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

Sets the bundle context value. The bundle context (BundleContext) parameter. The bundle context (BundleContext) parameter.

Parameters:

bundleContext - The bundle context (BundleContext) parameter.

See Also:

getBundleContext()

setConfigurationInformation

public void setConfigurationInformation(java.util.Dictionary configurationInformation)

Sets the configuration information value. The configuration information (Dictionary) parameter. The configuration information (Dictionary) parameter. The configuration information (Dictionary) parameter.

Parameters:

configurationInformation - The configuration information (Dictionary) parameter.

See Also:

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

setInformation

protected void setInformation(int information)

Sets the information property. The new property value (int). The information (int) parameter. The information (int) parameter.

Parameters:

information - The information (int) parameter.

See Also:

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

setListenersNull

public void setListenersNull()

Set listeners null.

setNotificationController

public void setNotificationController(NotificationController notificationController)

Sets the notification controller value. The notification controller (NotificationController) parameter. The notification controller (NotificationController) parameter.

Parameters:

notificationController - The notification controller (NotificationController) parameter.

See Also:

getNotificationController()

setNotificationService

public void setNotificationService(NotificationService notificationService)

Sets the notification service value. The notification service (NotificationService) parameter. The notification service (NotificationService) parameter. The notification service (NotificationService) parameter. The notification service (NotificationService) parameter.

Parameters:

notificationService - The notification service (NotificationService) parameter.

See Also:

getNotificationService()

setState

public void setState(int state)

Set the state of the Device. The state (int) parameter. The state (int) parameter. The state (int) parameter.

Parameters:

state - The state (int) parameter.

See Also:

getState()

setStyle

public void setStyle(short style)

Sets the style property. The new property value (short). The style (short) parameter. The style (short) parameter.

Parameters:

style - The style (short) parameter.

See Also:

getDefaultStyle(), getStyle()

setTransport

public void setTransport(TransportService transport)

Sets the transport property. The new property value (org.eclipse.soda.dk.transport.service.TransportService). The transport (TransportService) parameter. The transport (TransportService) parameter.

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.

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 buffer (StringBuffer) parameter.

Overrides:

toStringInfo in class EscObject

Parameters:

buffer - The buffer (StringBuffer) parameter.

transportStartedWait

public void transportStartedWait()

Active wait.

unregister

public void unregister(NotificationListener pubSubListener)

Unsubscribe with the specified arg0 parameter. The arg0 (NotificationListener) parameter. The pub sub listener (NotificationListener) parameter. The pub sub listener (NotificationListener) parameter.

Parameters:

pubSubListener - The pub sub listener (NotificationListener) parameter.

unsubscribe

public void unsubscribe()

Unsubscribe.