de.hawhamburg.reachability.reasoner

Class Reasoner

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.reasoner.Reasoner

All Implemented Interfaces:

PropertyServiceNotifiable, ReasoningEngine, StopableObject, java.lang.Runnable

Direct Known Subclasses:

DroolsBasedEngine, ExampleReasoner

public abstract class Reasoner
extends java.lang.Thread
implements StopableObject, ReasoningEngine, PropertyServiceNotifiable

Abstract class which needs to be extended by each Reasoner.

This abstract class needs to be extended by a Reasoner 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 de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	feedbackTopic The LPSubscriber, which will get user feedback from user interfaces.
private java.lang.String	feedbackTopicName The name of the ActiveMQ topic on which user feedback will be propagated.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	internalSensorDataTopic The LPPublisher, which will get the generalized result set from internalSensorDataTopicName.
private java.lang.String	internalSensorDataTopicName The name of the ActiveMQ topic on which the sensor publishes its generalized data set.
private PropertyService	propertyService The PropertyService of this Reasoner, which manages property requests and changes from user interfaces.
private java.util.Random	rand Local random number generator.
private java.lang.String	registryRequestTopicName The name of the ActiveMQ topic on which the systems registry service invites other components to join him.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	registryTopic The LPPublisher, which sends register messages to the systems registry service via the ActiveMQ.
private java.lang.String	registryTopicName The name of the ActiveMQ topic on which this Reasoner sends its register messages to the systems registry service.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	requestRegistryTopic The LPSubscriber, which listens for register requests from the systems registry service via the ActiveMQ.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	resultTopic The LPPublisher, which will write the results to the agents result.
private java.lang.String	resultTopicName The name of the ActiveMQ topic on which the sensor delivers its measuring 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 Reasoner has stopped.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface de.hawhamburg.reachability.reasoner.ReasoningEngine

PROPERTY_FILE_SOURCE_KEY

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	cleanUp() Cleans up by freeing all resources.
private void	end() Unregisters from systems registry service, disconnects all ActiveMQ topic connections and sets stopped to true.
protected java.lang.String	getID() Returns the ID of this Reasoner.
private JsonReachabilityInformation	getJsonReachabilityInformation() Returns a single JsonReachabilityInformation object which contains the ReachabilityStatus to all ReachabilityGroups and different identification informations.
protected java.lang.String	getVersion() Returns the version of this Reasoner.
private void	handleActiveUserFeedback() Handles active user feedback, if some new arises via the ActiveMQ.
private void	handleInternalSensorData() Forward internal sensor data to the reasoning engine, if some new arises via the ActiveMQ.
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.
private void	init() Initialize all required ActiveMQ connections and starts the property service of this Reasoner.
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
boolean	isSilent() Checks if the current workers running mode is silent or not.
private void	publishReachabilityStatus() The method will publish the current reachability status using the publisher resultTopic and getJsonReachabilityInformation().
protected void	pushProperties() Push current properties to other components via the ActiveMQ.
void	run() Frequently check for sensor data updates.
private void	sendInitialRegisterMessage() Sends an initial register message by using sendRegistryMessage(RegistryMessageType) with RegistryMessageType.REGISTER.
private void	sendRegistryMessage(RegistryMessageType type) Creates and sends a new JsonRARegistryMessage onto the registryTopic.
protected abstract void	setSensorData(JsonReachabilitySensorData data) Extracts dimension and sensor data from a received JsonReachabilitySensorData and adds them to the working memory.
void	setSilent(boolean state) Set the silent state.
void	shutDown() Shuts the object down.
boolean	stopped() Determines if the Reasoner 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

Methods inherited from interface de.hawhamburg.reachability.reasoner.ReasoningEngine

dump, getEstimatedReachability, getEstimatedReachability, handleFeedback, start

Methods inherited from interface de.hawhamburg.reachability.properties.PropertyServiceNotifiable

getValuesForProperty, loadCurrentProperties, updateProperties

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.

feedbackTopicName

private java.lang.String feedbackTopicName

The name of the ActiveMQ topic on which user feedback will be propagated.

resultTopicName

private java.lang.String resultTopicName

The name of the ActiveMQ topic on which the sensor delivers its measuring results.

internalSensorDataTopicName

private java.lang.String internalSensorDataTopicName

The name of the ActiveMQ topic on which the sensor publishes its generalized data set.

registryRequestTopicName

private java.lang.String registryRequestTopicName

The name of the ActiveMQ topic on which the systems registry service invites other components to join him.

registryTopicName

private java.lang.String registryTopicName

The name of the ActiveMQ topic on which this Reasoner sends its register messages to the systems registry service.

feedbackTopic

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

The LPSubscriber, which will get user feedback from user interfaces.

resultTopic

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

The LPPublisher, which will write the results to the agents result.

internalSensorDataTopic

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

The LPPublisher, which will get the generalized result set from internalSensorDataTopicName.

requestRegistryTopic

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

The LPSubscriber, which listens for register requests from the systems registry service via the ActiveMQ.

registryTopic

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

The LPPublisher, which sends register messages to the systems registry service via the ActiveMQ.

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

stopped

private boolean stopped

Determines if the Reasoner has stopped.

rand

private java.util.Random rand

Local random number generator.

propertyService

private PropertyService propertyService

The PropertyService of this Reasoner, which manages property requests and changes from user interfaces.

Constructor Detail

Reasoner

protected Reasoner()

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

Method Detail

setSilent

public final void setSilent(boolean state)

Set the silent state. If silent is set to true, the worker won't publish his informations on the general result topic.

Parameters:

state - The current state of silence as Boolean.

isSilent

public final boolean isSilent()

Checks if the current workers running mode is silent or not.

Specified by:

isSilent in interface PropertyServiceNotifiable

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 Reasoner has stopped.

Returns:

true if Reasoner 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()

run

public final void run()

Frequently check for sensor data updates. On success notify the reasoner.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

init

private void init()

Initialize all required ActiveMQ connections and starts the property service of this Reasoner.

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.

handleActiveUserFeedback

private void handleActiveUserFeedback()

Handles active user feedback, if some new arises via the ActiveMQ.

handleInternalSensorData

private void handleInternalSensorData()

Forward internal sensor data to the reasoning engine, if some new arises via the ActiveMQ.

setSensorData

protected abstract void setSensorData(JsonReachabilitySensorData data)

Extracts dimension and sensor data from a received JsonReachabilitySensorData and adds them to the working memory.

Parameters:

data - The JsonReachabilitySensorData which has been measured.

publishReachabilityStatus

private void publishReachabilityStatus()

The method will publish the current reachability status using the publisher resultTopic and getJsonReachabilityInformation().

getJsonReachabilityInformation

private JsonReachabilityInformation getJsonReachabilityInformation()

Returns a single JsonReachabilityInformation object which contains the ReachabilityStatus to all ReachabilityGroups and different identification informations. (For further informations see JsonReachabilityInformation).

Returns:

A new JSON object which can be published on an ActiveMQ as JsonReachabilityInformation.

end

private void end()

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

cleanUp

protected abstract void cleanUp()

Cleans up by freeing all resources.

sendRegistryMessage

private void sendRegistryMessage(RegistryMessageType type)

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

Parameters:

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

pushProperties

protected final void pushProperties()

Push current properties to other components via the ActiveMQ.

getID

protected final java.lang.String getID()

Returns the ID of this Reasoner.

Returns:

The ID of this Reasoner as String.

getVersion

protected final java.lang.String getVersion()

Returns the version of this Reasoner.

Returns:

The version of this Reasoner as String.