de.hawhamburg.reachability.properties

Class PropertyService

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.properties.PropertyService

All Implemented Interfaces:

StopableObject, java.lang.Runnable

public class PropertyService
extends java.lang.Thread
implements StopableObject

Main properties service class which handles property requests and changes via ActiveMQ.

This class represents a separately running service thread which handles the communication related to property requests and changes with the ActiveMQ at runtime. It will provide the at runtime defined properties to user interfaces, other systems and serves as interface for property changes. On such changes, this class will provide the update of the known system configuration of all related components and ensures that the configuration will be persisted to files for later restarts.

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 PropertyServiceNotifiable	agent The worker which called this property service.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	changeProps Listener for property change requests.
private org.w3c.dom.Document	parameterDescription Parameter description.
private java.lang.String	parameterDescriptionFile Path to the XML-file where the parameter description is located.
private java.util.Properties	props Basic (user-defined) properties.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	requestProps Listener for property requests.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	resultProps Publisher for property results.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	resultPropsReader Subscriber for other property results.
private boolean	shutDown Determines if the method shutDown() has been called.
private ConfigType	type Properties type.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PropertyService(PropertyServiceNotifiable theWorker, ConfigType supportedType) Create a new property service.
PropertyService(PropertyServiceNotifiable theWorker, ConfigType supportedType, java.lang.String parmDescFile) Create a new property service with a well known external properties description file.

Method Summary

Methods

Modifier and Type	Method and Description
private void	end() Gracefully end this service.
private java.lang.String	getID() Returns a service ID.
private java.util.Map<java.lang.String,java.lang.String>	getPropertiesAsMap(java.lang.String reqProps) Loads the required properties for the requested type by using loadProperties() and fetches the requested properties defined by the reqProps parameter.
private java.util.Map<java.lang.String,PropertyDescription>	getPropertiesDescriptionMap() Loads the properties descriptions from the external file and parses them out of the XML document.
private java.lang.String	getServiceStateReference() Returns the service state reference which entitles a change requests.
private java.lang.String	getVersion() Returns the agents version.
private void	handleChangeRequest() Handles a properties change requested on the ActiveMQ change topic (REACHABILITY_CONFIG_CHANGE_TOPIC).
private void	handleOtherConfigurations() There may arrive configuration results via the ActiveMQ which dosn't equal type.
private void	handleRequested() Handles a request for properties sent over the ActiveMQ request topic REACHABILITY_CONFIG_REQUEST_TOPIC by calling pushProperties(JsonRAPropertiesRequest).
private void	init() Initializes the ActiveMQ connections for request (REACHABILITY_CONFIG_REQUEST_TOPIC), response (REACHABILITY_CONFIG_RESULT_TOPIC) and change (REACHABILITY_CONFIG_CHANGE_TOPIC).
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
private void	loadProperties() Loads the currently defined properties by delegation to the agent.
private void	loadPropertiesDescription() Loads the currently defined properties descriptions.
void	pushProperties(JsonRAPropertiesRequest reqObj) Sends a JsonRAPropertiesResult JSON object on the result topic (REACHABILITY_CONFIG_RESULT_TOPIC) containing the requested properties which are determined by using getPropertiesAsMap(String) and their descriptions determined by getPropertiesDescriptionMap().
void	reloadProperties() Alias for loadProperties().
void	run() Run as long as shutDown() wasn't called.
void	shutDown() Shuts the object down.

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

props

private java.util.Properties props

Basic (user-defined) properties.

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

requestProps

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

Listener for property requests.

resultProps

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

Publisher for property results.

resultPropsReader

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

Subscriber for other property results.

changeProps

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

Listener for property change requests.

type

private ConfigType type

Properties type.

parameterDescriptionFile

private java.lang.String parameterDescriptionFile

Path to the XML-file where the parameter description is located.

parameterDescription

private org.w3c.dom.Document parameterDescription

Parameter description.

agent

private PropertyServiceNotifiable agent

The worker which called this property service.

Constructor Detail

PropertyService

public PropertyService(PropertyServiceNotifiable theWorker,
               ConfigType supportedType)

Create a new property service.

Parameters:

theWorker - The PropertyServiceNotifiable object which set up this property service reasoner and might be updated at runtime.

supportedType - The type of properties for which this service is primary responsible as ConfigType.

PropertyService

public PropertyService(PropertyServiceNotifiable theWorker,
               ConfigType supportedType,
               java.lang.String parmDescFile)

Create a new property service with a well known external properties description file.

Parameters:

theWorker - The PropertyServiceNotifiable object which set up this property service reasoner and might be updated at runtime.

supportedType - The type of properties for which this service is primary responsible as ConfigType.

parmDescFile - The path to the well known external properties description file as String.

Method Detail

loadProperties

private void loadProperties()

Loads the currently defined properties by delegation to the agent.

reloadProperties

public final void reloadProperties()

Alias for loadProperties().

loadPropertiesDescription

private void loadPropertiesDescription()

Loads the currently defined properties descriptions.

run

public final void run()

Run as long as shutDown() wasn't called.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

init

private void init()

Initializes the ActiveMQ connections for request (REACHABILITY_CONFIG_REQUEST_TOPIC), response (REACHABILITY_CONFIG_RESULT_TOPIC) and change (REACHABILITY_CONFIG_CHANGE_TOPIC).

handleRequested

private void handleRequested()

Handles a request for properties sent over the ActiveMQ request topic REACHABILITY_CONFIG_REQUEST_TOPIC by calling pushProperties(JsonRAPropertiesRequest).

pushProperties

public final void pushProperties(JsonRAPropertiesRequest reqObj)

Sends a JsonRAPropertiesResult JSON object on the result topic (REACHABILITY_CONFIG_RESULT_TOPIC) containing the requested properties which are determined by using getPropertiesAsMap(String) and their descriptions determined by getPropertiesDescriptionMap().

Parameters:

reqObj - A JsonRAPropertiesRequest JSON object representing the request.

getPropertiesAsMap

private java.util.Map<java.lang.String,java.lang.String> getPropertiesAsMap(java.lang.String reqProps)

Loads the required properties for the requested type by using loadProperties() and fetches the requested properties defined by the reqProps parameter.

Parameters:

reqProps - The requested property as String ("*ALL" is defined as wildcard for all properties).

Returns:

The properties and their values as Map of String to String.

getPropertiesDescriptionMap

private java.util.Map<java.lang.String,PropertyDescription> getPropertiesDescriptionMap()

Loads the properties descriptions from the external file and parses them out of the XML document.

Returns:

The properties description as Map of String (property) to PropertyDescription (description object of the property).

handleChangeRequest

private void handleChangeRequest()

Handles a properties change requested on the ActiveMQ change topic (REACHABILITY_CONFIG_CHANGE_TOPIC). It's changing its local copies of these properties and informs the creator of this service by using PropertyServiceNotifiable.updateProperties(Properties, Properties, ConfigType) on agent.

handleOtherConfigurations

private void handleOtherConfigurations()

There may arrive configuration results via the ActiveMQ which dosn't equal type. These updates may be important for the agent as well, so they need to be forwarded to it by this method.

end

private void end()

Gracefully end this service.

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

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

getID

private java.lang.String getID()

Returns a service ID.

Returns:

The service ID containing the ProjectInfo.REACHABILITY_AGENT_WORKER_NAME, the services name and a pseudo random number.

getServiceStateReference

private java.lang.String getServiceStateReference()

Returns the service state reference which entitles a change requests.

Returns:

The service state reference which is required for change requests.

getVersion

private java.lang.String getVersion()

Returns the agents version.

Returns:

The agents version as ProjectInfo.REACHABILITY_AGENT_VERSION.