de.hawhamburg.reachability

Class ReachabilityWorker

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.ReachabilityWorker

All Implemented Interfaces:

PropertyServiceNotifiable, StopableObject, java.lang.Runnable

public class ReachabilityWorker
extends java.lang.Thread
implements StopableObject, PropertyServiceNotifiable

The ReachabilityWorker is a thread which mainly serves as control service. It starts a property and a configuration service and coordinates different distributed components of this systems. These components may be sensor or reasoner adapters, service and user interfaces.

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 boolean	active Holds the activity state of this object.
private boolean	ended Holds the information, if run() statement has ended or not.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	globalControlTopic The LPPublisher which sends control messages to other components via the ActiveMQ.
private PropertyService	propertyService The property service thread PropertyService.
private java.util.List<java.lang.String>	registeredReasoners A List of registered reasoners.
private java.util.Map<ReasonerDimension,java.util.List<java.lang.String>>	registeredSensors A Map of context dimensions (ReasonerDimension) to a List of sensors.
private Registry	registryService The registry service thread Registry.
private java.lang.String	runningReasoner The actual running reasoner.
private java.util.Map<ReasonerDimension,java.lang.String>	runningSensors A Map of context dimensions (ReasonerDimension) to sensor agents, which contains all actual running sensor agents and their specific context dimension.
private boolean	shutDown Determines if the method shutDown() has been called.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ReachabilityWorker() Constructs a new ReachabilityWorker object.

Method Summary

Methods

Modifier and Type	Method and Description
void	activ(boolean pred) Method to set the active status active.
private void	end() The method will be called at the end of the method run() and will notify all connected sensor adapters and the reasoners.
boolean	ended() Determines if the thread has ended its run() method.
java.util.Map<java.lang.String,java.lang.String>	getValuesForProperty(java.lang.String property) It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime.
private java.lang.String	getVersion() Returns the agents version.
private void	init() This method opens the required ActiveMQ connections.
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
boolean	isSilent() Determines if the thread is running in silent mode.
java.util.Properties	loadCurrentProperties(ConfigType propertiesType) The PropertyService requests the actual properties of a certain ConfigType from its creator.
void	register(RegistryAgentType type, java.lang.String name, ReasonerDimension dimension) Registers a new component.
void	run() General run method which calls the initialize and end methods and coordinates the different components.
private void	sendControlMessage(ConfigOrder order, java.lang.String id) Sends a new control message.
void	shutDown() Shuts the object down.
private void	shutDownAllSensorAdapters() Stops all active sensor agents.
private void	shutDownReasoningEngine() Stops the active reasoning engine.
private void	startReasoningEngine(java.lang.String reasoner) Starts a certain reasoner agent by sending a start control message.
private void	startSensor(ReasonerDimension dimension, java.lang.String sensor) Starts a certain sensor agent by sending a start control message.
private void	stopReasoningEngine(java.lang.String reasoner) Stops a certain reasoner agent by sending a sleep control message.
private void	stopSensor(ReasonerDimension dimension, java.lang.String sensor) Stops a certain sensor agent by sending a sleep control message.
private void	suspendReasoningEngine(java.lang.String reasoner) Suspends a certain reasoner agent by sending a sleep control message.
private void	suspendSensor(ReasonerDimension dimension, java.lang.String sensor) Suspends a certain sensor agent by sending a sleep control message.
void	unregister(RegistryAgentType type, java.lang.String name, ReasonerDimension dimension) Unregisters a component (sensor or reasoner agent) and handles its consequences.
void	updateProperties(java.util.Properties newProps, java.util.Properties changedProps, ConfigType type) Updates the local properties by new ones.

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

active

private boolean active

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

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

ended

private boolean ended

Holds the information, if run() statement has ended or not.

globalControlTopic

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

The LPPublisher which sends control messages to other components via the ActiveMQ.

registeredReasoners

private java.util.List<java.lang.String> registeredReasoners

A List of registered reasoners.

runningReasoner

private java.lang.String runningReasoner

The actual running reasoner.

registeredSensors

private java.util.Map<ReasonerDimension,java.util.List<java.lang.String>> registeredSensors

A Map of context dimensions (ReasonerDimension) to a List of sensors. This map holds all registered sensor agents and their specific context dimensions.

runningSensors

private java.util.Map<ReasonerDimension,java.lang.String> runningSensors

A Map of context dimensions (ReasonerDimension) to sensor agents, which contains all actual running sensor agents and their specific context dimension.

propertyService

private PropertyService propertyService

The property service thread PropertyService.

registryService

private Registry registryService

The registry service thread Registry.

Constructor Detail

ReachabilityWorker

public ReachabilityWorker()

Constructs a new ReachabilityWorker object. It initializes different instance variables.

Method Detail

activ

public final void activ(boolean pred)

Method to set the active status active. If the method is called with its parameter set to false, the worker will stop publishing its results on the result topic.

Parameters:

pred - If false the worker will stop publishing results on the result topic.

isSilent

public final boolean isSilent()

Determines if the thread is running in silent mode.

Specified by:

isSilent in interface PropertyServiceNotifiable

Returns:

true if the worker is running in silent mode, 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()

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

ended

public final boolean ended()

Determines if the thread has ended its run() method.

Returns:

true if the thread has ended, otherwise false.

run

public final void run()

General run method which calls the initialize and end methods and coordinates the different components.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

See Also:

Thread.run()

init

private void init()

This method opens the required ActiveMQ connections. Furthermore it starts the property and registry service.

startReasoningEngine

private void startReasoningEngine(java.lang.String reasoner)

Starts a certain reasoner agent by sending a start control message.

Parameters:

reasoner - The reasoner agents name as String.

suspendReasoningEngine

private void suspendReasoningEngine(java.lang.String reasoner)

Suspends a certain reasoner agent by sending a sleep control message.

Parameters:

reasoner - The reasoner agents name as String.

stopReasoningEngine

private void stopReasoningEngine(java.lang.String reasoner)

Stops a certain reasoner agent by sending a sleep control message.

Parameters:

reasoner - The reasoner agents name as String.

startSensor

private void startSensor(ReasonerDimension dimension,
               java.lang.String sensor)

Starts a certain sensor agent by sending a start control message.

Parameters:

dimension - The sensor agents supported context dimension as ReasonerDimension.

sensor - The sensor agents name as String.

suspendSensor

private void suspendSensor(ReasonerDimension dimension,
                 java.lang.String sensor)

Suspends a certain sensor agent by sending a sleep control message.

Parameters:

dimension - The sensor agents supported context dimension as ReasonerDimension.

sensor - The sensor agents name as String.

stopSensor

private void stopSensor(ReasonerDimension dimension,
              java.lang.String sensor)

Stops a certain sensor agent by sending a sleep control message.

Parameters:

dimension - The sensor agents supported context dimension as ReasonerDimension.

sensor - The sensor agents name as String.

sendControlMessage

private void sendControlMessage(ConfigOrder order,
                      java.lang.String id)

Sends a new control message.

Parameters:

order - The ConfigOrder for control message.

id - The recipients ID which shall receive the control message.

end

private void end()

The method will be called at the end of the method run() and will notify all connected sensor adapters and the reasoners. Furthermore it disconnects all open ActiveMQ topics and shut down all started services.

shutDownAllSensorAdapters

private void shutDownAllSensorAdapters()

Stops all active sensor agents.

shutDownReasoningEngine

private void shutDownReasoningEngine()

Stops the active reasoning engine.

updateProperties

public final void updateProperties(java.util.Properties newProps,
                    java.util.Properties changedProps,
                    ConfigType type)

Updates the local properties by new ones. This method will be called by the PropertyService if a new configuration arises on the ActiveMQ.

Specified by:

updateProperties in interface PropertyServiceNotifiable

Parameters:

newProps - The new Properties set.

changedProps - Only the changed Properties.

type - The type of properties as ConfigType.

loadCurrentProperties

public final java.util.Properties loadCurrentProperties(ConfigType propertiesType)

Description copied from interface: PropertyServiceNotifiable

The PropertyService requests the actual properties of a certain ConfigType from its creator. The creator should reload its local property set and return them to the PropertyService.

Specified by:

loadCurrentProperties in interface PropertyServiceNotifiable

Parameters:

propertiesType - The ConfigType for which the local properties shall be loaded an returned.

Returns:

The properties if known.

See Also:

PropertyServiceNotifiable.loadCurrentProperties(ConfigType)

getValuesForProperty

public final java.util.Map<java.lang.String,java.lang.String> getValuesForProperty(java.lang.String property)

Description copied from interface: PropertyServiceNotifiable

It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime. In this case, the PropertyService asks its creator about the current value range of this property by using this method.

Specified by:

getValuesForProperty in interface PropertyServiceNotifiable

Parameters:

property - The name of the requested property.

Returns:

The dynamic set of values for this property.

See Also:

PropertyServiceNotifiable.getValuesForProperty(String)

register

public final void register(RegistryAgentType type,
            java.lang.String name,
            ReasonerDimension dimension)

Registers a new component. This may be a sensor or reasoner agent.

Parameters:

type - The component type as value of RegistryAgentType.

name - The name of the new component (the ID on which it reacts on control messages).

dimension - The supported context dimension (required for RegistryAgentType.SENSOR.

unregister

public final void unregister(RegistryAgentType type,
              java.lang.String name,
              ReasonerDimension dimension)

Unregisters a component (sensor or reasoner agent) and handles its consequences.

Parameters:

type - The component type as value of RegistryAgentType.

name - The name of the leaving component (the ID on which it reacts on control messages).

dimension - The supported context dimension (required for RegistryAgentType.SENSOR.

getVersion

private java.lang.String getVersion()

Returns the agents version.

Returns:

The agents version as ProjectInfo.REACHABILITY_AGENT_VERSION.