org.lsst.ccs.services

Interface AgentMonitor

All Known Implementing Classes:

AgentExecutionService, RuntimeService

public interface AgentMonitor

An Interface to be implemented by all nodes that provide an insight in the Agent's health and safety.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getAgentMonitorStatus

String getAgentMonitorStatus(boolean useCcsBuses)

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.

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

String getAgentMonitorDescription()

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

Returns:

The description for this AgentMonitor.