de.hawhamburg.reachability

Class ReachabilityAgent

java.lang.Object

de.hawhamburg.reachability.ReachabilityAgent

All Implemented Interfaces:

LifeCycleAgent

public class ReachabilityAgent
extends java.lang.Object
implements LifeCycleAgent

This is the main class for starting up the reachability agent. It will open a new ReachabilityWorker an start it on request. It also implements the living place (LP) life cycle agent, so it listens on the messages "start", "sleep", "info" and "stop" via the global control topic.

Version:

"2013.42"

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private ProjectStatus	myStatus The current project status of the reachability agent as ProjectStatus object.
private static long	SHUTDOWN_CHECKTIME Time to wait before check again if the worker has already been stopped, while stop() is ending the worker thread, before sending success.
private ReachabilityWorker	worker The ReachabilityWorker, a thread determining the current state of reachability of an inhabitant.

Constructor Summary

Constructors

Constructor and Description
ReachabilityAgent() Creates a new ReachabilityAgent which starts a ReachabilityWorker to determine the inhabitants current state of reachability.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getID() the identifier of the Application.
JsonInfoMessage	getInfoMessage() Generating a Info Message.
static void	main(java.lang.String[] args) This method starts and runs a new ReachabilityAgent.
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

SHUTDOWN_CHECKTIME

private static final long SHUTDOWN_CHECKTIME

Time to wait before 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 ReachabilityWorker worker

The ReachabilityWorker, a thread determining the current state of reachability of an inhabitant.

myStatus

private ProjectStatus myStatus

The current project status of the reachability agent as ProjectStatus object.

Constructor Detail

ReachabilityAgent

public ReachabilityAgent()

Creates a new ReachabilityAgent which starts a ReachabilityWorker to determine the inhabitants current state of reachability.

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 object describing the current systems state.

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.

See Also:

LifeCycleAgent.getID()

main

public static void main(java.lang.String[] args)

This method starts and runs a new ReachabilityAgent.

Parameters:

args - The command line arguments as array of String.