de.hawhamburg.reachability.sensor

Class SensorAgent

java.lang.Object

de.hawhamburg.reachability.sensor.SensorAgent

All Implemented Interfaces:

LifeCycleAgent

public class SensorAgent
extends java.lang.Object
implements LifeCycleAgent

Class to manage the "Living Place Agent Life Cycle" for SensorAdapters.

This class handles the requests related to the "living place agent life cycle" specification, which will be supplied on a global control topic via the ActiveMQ. It implements the LifeCycleAgent interface and will be instantiated with an SensorAdapter, which will be started immediately. Furthermore it will wrap the running SensorAdapter by a LifeCycleApp. Nevertheless, this class implements the control actions related to a SensorAdapter, such as: "start", "sleep", "info" and "stop".

Version:

"2013.42"

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private ProjectStatus	myStatus The current status of the sensor agent.
private static long	SHUTDOWN_CHECKTIME Time to wait to check again if the worker has already been stopped, while stop() is ending the worker thread, before sending success.
private SensorAdapter	worker The SensorAdapter, a thread which provides sensor data of a certain context dimension in an internal data format.
private ReasonerDimension	workerDimension The context dimension as ReasonerDimension for which the worker provides sensor data.
private java.lang.String	workerName The simple class name of the worker.

Constructor Summary

Constructors

Constructor and Description
SensorAgent(SensorAdapter adapter) Create a new SensorAgent which starts the supplied SensorAdapter as LifeCycleApp and manages control messages for this SensorAdapter, such as "start", "stop", "info" and "sleep".

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getID() the identifier of the Application.
JsonInfoMessage	getInfoMessage() Generating a Info Message.
void	sleep() the application no longer communicates with the Blackboard.
void	start() start with the actual work.
void	stop() shutting the agent down.

Methods inherited from class java.lang.Object

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

Field Detail

myStatus

private ProjectStatus myStatus

The current status of the sensor agent.

SHUTDOWN_CHECKTIME

private static final long SHUTDOWN_CHECKTIME

Time to wait to check again if the worker has already been stopped, while stop() is ending the worker thread, before sending success.

See Also:

Constant Field Values

worker

private SensorAdapter worker

The SensorAdapter, a thread which provides sensor data of a certain context dimension in an internal data format.

workerName

private java.lang.String workerName

The simple class name of the worker.

workerDimension

private ReasonerDimension workerDimension

The context dimension as ReasonerDimension for which the worker provides sensor data.

Constructor Detail

SensorAgent

public SensorAgent(SensorAdapter adapter)

Create a new SensorAgent which starts the supplied SensorAdapter as LifeCycleApp and manages control messages for this SensorAdapter, such as "start", "stop", "info" and "sleep".

Parameters:

adapter - The SensorAdapter which shall be started and managed as LifeCycleApp.

Method Detail

sleep

public final void sleep()

Description copied from interface: LifeCycleAgent

the application no longer communicates with the Blackboard.

Specified by:

sleep in interface LifeCycleAgent

See Also:

LifeCycleAgent.sleep()

getInfoMessage

public final JsonInfoMessage getInfoMessage()

Description copied from interface: LifeCycleAgent

Generating a Info Message.

Specified by:

getInfoMessage in interface LifeCycleAgent

Returns:

A JsonInfoMessage, which describes the current execution state of the managed SensorAdapter.

See Also:

LifeCycleAgent.getInfoMessage()

start

public final void start()

Description copied from interface: LifeCycleAgent

start with the actual work.

Specified by:

start in interface LifeCycleAgent

See Also:

LifeCycleAgent.start()

stop

public final void stop()

Description copied from interface: LifeCycleAgent

shutting the agent down.

Specified by:

stop in interface LifeCycleAgent

See Also:

LifeCycleAgent.stop()

getID

public final java.lang.String getID()

Description copied from interface: LifeCycleAgent

the identifier of the Application.

Specified by:

getID in interface LifeCycleAgent

Returns:

The ID of this service as String defined by ProjectInfo.REACHABILITY_AGENT_NAME. This exact ID needs to be provided within a control message to take effect on this SensorAgent.

See Also:

LifeCycleAgent.getID()