org.lsst.ccs.services

Class RuntimeService

java.lang.Object

org.lsst.ccs.services.RuntimeService

All Implemented Interfaces:

AlertHandler, ClearAlertHandler, HasLifecycle, ServiceLifecycle, AgentMonitor

public final class RuntimeService
extends Object
implements ServiceLifecycle, HasLifecycle, AgentMonitor, ClearAlertHandler

A Service to provide jmx access to the Agetn's runtime. It also monitors possible dead-locks.

Author:

The LSST CCS Team

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

ClearAlertHandler.ClearAlertCode

Constructor Summary

Constructors

Constructor and Description
RuntimeService(Agent a) Create an instance of the RuntimeSerice for a given Agent.

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
ClearAlertHandler.ClearAlertCode	canClearAlert(Alert alert) Callback to clear an Alert instance.
String	getAgentMonitorDescription() Get the description for this AgentMonitor.
String	getAgentMonitorStatus(boolean useCcsBuses) This method should return the string "OK" if everything is working as expected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

preBuild, preInit, preShutdown, preStart

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

init, postBuild, postInit, postShutdown, postStart, shutdown, start

Constructor Detail

RuntimeService

public RuntimeService(Agent a)

Create an instance of the RuntimeSerice for a given Agent.

Parameters:

a - The Agent this Service belongs to.

Method Detail

build

public void build()

Description copied from interface: HasLifecycle

First lifecycle hook. Modification of the component tree is allowed at this stage. After this stage the tree of component cannot be modified anymore. This is where agent periodic tasks should be scheduled.

Specified by:

build in interface HasLifecycle

getAgentMonitorStatus

public String getAgentMonitorStatus(boolean useCcsBuses)

Description copied from interface: AgentMonitor

This method should return the string "OK" if everything is working as expected. Otherwise it should return a message explaining the problem. This method is meant to be invoked from two places: - by a JMX environment - by a periodic task within the Agent It should be quick at evaluating the Agent status. In an attempt to de-couple the status of an Agent from the status of the buses, when this method is invoked from JMX there should be no attempt at using the CCS buses. The provided boolean parameter tells if the method is being invoked form jmx or from the periodic task. Specific implementations should make sure that access to this method is synchronized.

Specified by:

getAgentMonitorStatus in interface AgentMonitor

Parameters:

useCcsBuses - a boolean to tell if the CCS buses should be used: for example to raise an Alert. This is true when the method is invoked from the periodic task. If it's invoked form JMX its value is false.

Returns:

The Status of the AgentMonitor.

getAgentMonitorDescription

public String getAgentMonitorDescription()

Description copied from interface: AgentMonitor

Get the description for this AgentMonitor. This will be used when logging check information.

Specified by:

getAgentMonitorDescription in interface AgentMonitor

Returns:

The description for this AgentMonitor.

canClearAlert

public ClearAlertHandler.ClearAlertCode canClearAlert(Alert alert)

Description copied from interface: ClearAlertHandler

Callback to clear an Alert instance. Return true/false if the Alert can be cleared. When true is returned the Alert is cleared and no more handlers will be checked. When false is returned other handlers will be handed the Alert instance to be cleared. If no handler returns true, the Alert will not be cleared.

Specified by:

canClearAlert in interface ClearAlertHandler

Parameters:

alert - The Alert instance to clear.

Returns:

A ClearAlertCode to indicate which action is to be taken by the framework.