org.lsst.ccs.services

Class RuntimeService

java.lang.Object

org.lsst.ccs.services.RuntimeService

All Implemented Interfaces:

AlertHandler, ClearAlertHandler, HasLifecycle, ServiceLifecycle, AgentMonitor, AgentService

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

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

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
ClearAlertHandler.ClearAlertCode	canClearAlert(Alert alert, AlertState state) 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.
String	getAgentServiceName() Get the name of this service.
boolean	startForAgent(AgentInfo agentInfo) This method is invoked after an agent service is created to see if this service is to be started for the tiven Agent.

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

afterInit, afterStart, 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()

Method Detail

getAgentServiceName

public String getAgentServiceName()

Description copied from interface: AgentService

Get the name of this service. This name will be used to add the given service to the lookup tree.

Specified by:

getAgentServiceName in interface AgentService

Returns:

the AgentService name.

startForAgent

public boolean startForAgent(AgentInfo agentInfo)

Description copied from interface: AgentService

This method is invoked after an agent service is created to see if this service is to be started for the tiven Agent.

Specified by:

startForAgent in interface AgentService

Returns:

true if the service is to be added to the given agent.

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,
                                                      AlertState state)

Description copied from interface: ClearAlertHandler

Callback to clear an Alert instance. Return a ClearAlertCode for the provided Alert.

Specified by:

canClearAlert in interface ClearAlertHandler

Parameters:

alert - The Alert instance to clear.

state - The AlertState for the provided Alert.

Returns:

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