de.hawhamburg.reachability.sensor

Class Sensor

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.sensor.Sensor

All Implemented Interfaces:

StopableObject, java.lang.Runnable

Direct Known Subclasses:

ExampleAdapter, GoogleCalendarAdapter, GoogleCalendarHookAdapter, LP3DObjectLocationAdapter, RSDFAdapter, StressCompanionAdapter, TimeAdapter

public abstract class Sensor
extends java.lang.Thread
implements StopableObject

Abstract class which needs to be extended by each SensorAdapter.

This abstract class needs to be extended by a SensorAdapter to be used in common with the reachability project. It provides some ActiveMQ connection relevant methods, to extremely simplify the sensor adapter design.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private long	delay Default delay time.
private ReasonerDimension	internalDimension The context dimension as ReasonerDimension for which this sensor supplies data inputs.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	internalSensorDataTopic The LPPublisher, which publishes the generalized result set on the internal result topic internalSensorDataTopicName.
private java.lang.String	internalSensorDataTopicName The ActiveMQ topic name on which the Sensor publishes its generalized data set for the reasoner.
private java.util.Map<java.lang.String,java.lang.String>	localConf Local adapter configuration.
private java.util.Random	rand Local random number generator.
private java.lang.String	registryRequestTopicName The ActiveMQ topic name on which reachability systems registry service will send its registry invitations.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	registryTopic The LPPublisher, which publishes register messages onto the systems registry register topic registryTopicName.
private java.lang.String	registryTopicName The ActiveMQ topic name on which clients send their registration messages to the systems registry service.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	requestRegistryTopic The LPSubscriber, which listens for register requests on the systems registry request topic registryRequestTopicName.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	requestTopic The LPPublisher, which publishes requests to the sensors data source request topic requestTopicName.
private java.lang.String	requestTopicName The ActiveMQ topic name on which a request shall be send to the sensors data source.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	resultTopic The LPSubscriber, which receives results from the sensors data source result topic resultTopicName.
private java.lang.String	resultTopicName The ActiveMQ topic name on which the sensors data source provides its measured results.
private boolean	shutDown Determines if the method shutDown() has been called.
private boolean	silent Holds the activity state of this object.
private boolean	stopped Determines if the Sensor has stopped.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Sensor(ReasonerDimension dimension) Protected constructor ensures, that there will be no direct instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Connects the Sensor to the topics via ActiveMQ, using the utility class ConnectionUtil.
private void	end() Unregisters from systems registry service, disconnects all ActiveMQ topic connections and sets stopped to true.
ReasonerDimension	getDataDimension() Provides the context dimension of the Sensors data as ReasonerDimension.
private JsonReachabilitySensorData	getDataMessage(SensorData so) Creates a new JsonReachabilitySensorData message based on a supplied SensorData.
java.lang.String	getID() Returns the ID of this Sensor.
protected java.lang.String	getLocalConf(java.lang.String key) Returns the value of the supplied local adapter parameter key if exiting, otherwise null.
protected de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	getRequestTopic() Returns the current LPPublisher object, which is connected to the internally defined request topic of this Sensors data source.
java.lang.String	getRequestTopicName() Provides the name of the request topic for ActiveMQ communication, if this Sensor is connect to its data source via ActiveMQ.
protected de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	getResultTopic() Returns the current LPSubscriber object, which is connected to the internally defined result topic of this Sensors data source.
java.lang.String	getResultTopicName() Provides the name of the result topic for ActiveMQ communication, if this Sensor is connect to its data source via ActiveMQ.
abstract SensorData	getSensorOutput() Provides the current SensorData and null if none exists.
protected java.lang.String	getVersion() Returns the version of this Sensor.
private void	handleRegisterRequestMessage() Checks for new registry invitations from the systems registry service and sends register message if there's some by using sendRegistryMessage(RegistryMessageType) with RegistryMessageType.REGISTER.
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
protected boolean	isSilent() Determines if the Sensors running mode is silent.
protected void	loadDefaultsFromXMLResource() Loads the sensors local configuration from its XML configuration file.
void	run() Main run method.
private void	sendInitialRegisterMessage() Sends an initial register message by using sendRegistryMessage(RegistryMessageType) with RegistryMessageType.REGISTER.
private void	sendInternalSensorData(SensorData so) Sends the measured SensorData as common internal representation onto the internal data exchange topic internalSensorDataTopicName, if this Sensor dosn't run in silent mode (isSilent()).
private void	sendRegistryMessage(RegistryMessageType type) Creates and sends a new JsonRARegistryMessage onto the registryTopic.
protected void	setDelay(long newDelay) Updates or sets the internal delay time to a new value.
protected void	setLocalConf(java.lang.String key, java.lang.String value) Set a local adapter configuration parameter key to value.
protected void	setRequestTopicName(java.lang.String newTopicName) Updates or sets the internal request topic name to a new value.
protected void	setResultTopicName(java.lang.String newTopicName) Updates or sets the internal result topic name to a new value.
void	setSilent(boolean state) Sets the silent state.
void	shutDown() Shuts the object down.
boolean	stopped() Determines if the Sensor has stopped.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

silent

private boolean silent

Holds the activity state of this object. If silent is true, the worker won't publish its results on the result topic.

requestTopicName

private java.lang.String requestTopicName

The ActiveMQ topic name on which a request shall be send to the sensors data source.

resultTopicName

private java.lang.String resultTopicName

The ActiveMQ topic name on which the sensors data source provides its measured results.

internalSensorDataTopicName

private java.lang.String internalSensorDataTopicName

The ActiveMQ topic name on which the Sensor publishes its generalized data set for the reasoner.

registryRequestTopicName

private java.lang.String registryRequestTopicName

The ActiveMQ topic name on which reachability systems registry service will send its registry invitations.

registryTopicName

private java.lang.String registryTopicName

The ActiveMQ topic name on which clients send their registration messages to the systems registry service.

requestTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher requestTopic

The LPPublisher, which publishes requests to the sensors data source request topic requestTopicName.

resultTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber resultTopic

The LPSubscriber, which receives results from the sensors data source result topic resultTopicName.

internalSensorDataTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher internalSensorDataTopic

The LPPublisher, which publishes the generalized result set on the internal result topic internalSensorDataTopicName.

requestRegistryTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber requestRegistryTopic

The LPSubscriber, which listens for register requests on the systems registry request topic registryRequestTopicName.

registryTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher registryTopic

The LPPublisher, which publishes register messages onto the systems registry register topic registryTopicName.

internalDimension

private ReasonerDimension internalDimension

The context dimension as ReasonerDimension for which this sensor supplies data inputs.

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

delay

private long delay

Default delay time.

rand

private java.util.Random rand

Local random number generator.

localConf

private java.util.Map<java.lang.String,java.lang.String> localConf

Local adapter configuration.

stopped

private boolean stopped

Determines if the Sensor has stopped.

Constructor Detail

Sensor

protected Sensor(ReasonerDimension dimension)

Protected constructor ensures, that there will be no direct instance of this class.

Parameters:

dimension - The ReasonerDimension for which this sensor is configured.

Method Detail

connect

public final void connect()

Connects the Sensor to the topics via ActiveMQ, using the utility class ConnectionUtil.

setSilent

public final void setSilent(boolean state)

Sets the silent state. If silent is set to true, the Sensor won't publish his informations onto the internal result topic for the reasoner.

Parameters:

state - The current state of silence as Boolean.

isSilent

protected final boolean isSilent()

Determines if the Sensors running mode is silent.

Returns:

The current state of silence as Boolean.

isActive

public final boolean isActive()

Description copied from interface: StopableObject

Determines whether the method StopableObject.shutDown() has been called on this object or not.

Specified by:

isActive in interface StopableObject

Returns:

true if shutDown() wasn't called, otherwise false.

See Also:

StopableObject.isActive()

stopped

public final boolean stopped()

Determines if the Sensor has stopped.

Returns:

true if Sensor has stopped, otherwise false.

shutDown

public final void shutDown()

Description copied from interface: StopableObject

Shuts the object down. The method shall ensure, that all opened or started resources (e.g. ActiveMQ connections, started threads) will be controlled shut down before the objects ends itself.

Specified by:

shutDown in interface StopableObject

See Also:

StopableObject.shutDown()

getRequestTopicName

public final java.lang.String getRequestTopicName()

Provides the name of the request topic for ActiveMQ communication, if this Sensor is connect to its data source via ActiveMQ.

Returns:

The request topic name of this Sensors data source if its connected via ActiveMQ, otherwise null.

getResultTopicName

public final java.lang.String getResultTopicName()

Provides the name of the result topic for ActiveMQ communication, if this Sensor is connect to its data source via ActiveMQ.

Returns:

The result topic name of this Sensors data source if its connected via ActiveMQ, otherwise null.

getDataDimension

public final ReasonerDimension getDataDimension()

Provides the context dimension of the Sensors data as ReasonerDimension.

Returns:

The ReasonerDimension of the Sensor.

getSensorOutput

public abstract SensorData getSensorOutput()

Provides the current SensorData and null if none exists.

Returns:

A SensorData object on success, otherwise null.

run

public final void run()

Main run method. Initializes processing by using sendInitialRegisterMessage() and frequently does:

• Check for register invitations from the systems registry service by using handleRegisterRequestMessage()
• Check for new sensor data from the Sensors data source by using getSensorOutput()
• Push new sensor data onto the internal data exchange topic by using sendInternalSensorData(SensorData)

while isActive(). Afterwards cleaning up all resources by using end().

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

end

private void end()

Unregisters from systems registry service, disconnects all ActiveMQ topic connections and sets stopped to true.

sendInitialRegisterMessage

private void sendInitialRegisterMessage()

Sends an initial register message by using sendRegistryMessage(RegistryMessageType) with RegistryMessageType.REGISTER.

handleRegisterRequestMessage

private void handleRegisterRequestMessage()

Checks for new registry invitations from the systems registry service and sends register message if there's some by using sendRegistryMessage(RegistryMessageType) with RegistryMessageType.REGISTER.

sendRegistryMessage

private void sendRegistryMessage(RegistryMessageType type)

Creates and sends a new JsonRARegistryMessage onto the registryTopic. This may register or unregister this Sensor due to the supplied RegistryMessageType.

Parameters:

type - The RegistryMessageType which indicates if the Sensor shall be registered or unregistered from the systems registry service.

setRequestTopicName

protected final void setRequestTopicName(java.lang.String newTopicName)

Updates or sets the internal request topic name to a new value.

Parameters:

newTopicName - The new name of the request topic as String.

setResultTopicName

protected final void setResultTopicName(java.lang.String newTopicName)

Updates or sets the internal result topic name to a new value.

Parameters:

newTopicName - The new name of the result topic as String.

setDelay

protected final void setDelay(long newDelay)

Updates or sets the internal delay time to a new value.

Parameters:

newDelay - The new delay time as long representing milliseconds.

setLocalConf

protected final void setLocalConf(java.lang.String key,
                java.lang.String value)

Set a local adapter configuration parameter key to value.

Parameters:

key - The key of the local adapter parameter as String.

value - The (new) value of the local adapter parameter as String.

getLocalConf

protected final java.lang.String getLocalConf(java.lang.String key)

Returns the value of the supplied local adapter parameter key if exiting, otherwise null.

Parameters:

key - The local adapter parameter key as String.

Returns:

The value if the local adapter parameter key as String if existing, otherwise null.

getResultTopic

protected final de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber getResultTopic()

Returns the current LPSubscriber object, which is connected to the internally defined result topic of this Sensors data source.

Returns:

The LPSubscriber object which is connected to the result topic.

getRequestTopic

protected final de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher getRequestTopic()

Returns the current LPPublisher object, which is connected to the internally defined request topic of this Sensors data source.

Returns:

The LPPublisher object which is connected to the request topic.

loadDefaultsFromXMLResource

protected final void loadDefaultsFromXMLResource()

Loads the sensors local configuration from its XML configuration file. The XML file shall be located at the path defined by Settings.SENSOR_CONFIGURATION_PATH and be named like the adapters simple class name.

These configuration files needs to contain the following xPaths:

• Settings.SENSOR_RESULT_TOPIC_XPATH
• Settings.SENSOR_RESULT_TOPIC_XPATH
• Settings.SENSOR_RESULT_TOPIC_XPATH

Optionally it can contain one or more Settings.SENSOR_LOCAL_CONF_XPATH.

sendInternalSensorData

private void sendInternalSensorData(SensorData so)

Sends the measured SensorData as common internal representation onto the internal data exchange topic internalSensorDataTopicName, if this Sensor dosn't run in silent mode (isSilent()).

Parameters:

so - The measured data as SensorData object.

getDataMessage

private JsonReachabilitySensorData getDataMessage(SensorData so)

Creates a new JsonReachabilitySensorData message based on a supplied SensorData.

Parameters:

so - The measured data as SensorData.

Returns:

A JsonReachabilitySensorData message based on the supplied SensorData.

getID

public final java.lang.String getID()

Returns the ID of this Sensor.

Returns:

The ID of this Sensor as String.

getVersion

protected final java.lang.String getVersion()

Returns the version of this Sensor.

Returns:

The version of this Sensor as String.