org.lsst.ccs.monitor

Class AlertRaisingAlarm

java.lang.Object

org.lsst.ccs.monitor.Alarm

org.lsst.ccs.monitor.AlertRaisingAlarm

All Implemented Interfaces:

AlertHandler, ClearAlertHandler, HasLifecycle

public abstract class AlertRaisingAlarm
extends Alarm
implements ClearAlertHandler

An Alarm that raises Alerts rather than notifying AlertHandlers. This class also implements the ClearAlertHandler: a class that raises an Alert should also be responsible for clearing it when a request is issued. The default implementation of the ClearAlertHandler is to clear any alert raised by this AlertRaisingAlarm instance that is not in AlarmState.ALARM state.

Author:

The LSSTCCS Team

Nested Class Summary

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

ClearAlertHandler.ClearAlertCode

Field Summary

Fields inherited from class org.lsst.ccs.monitor.Alarm

description, EVENT_LIMBO, EVENT_LIMBO_FROM_ERROR, EVENT_LIMBO_FROM_GOOD, EVENT_RESET, EVENT_TRIP, eventParm, name

Constructor Summary

Constructors

Constructor and Description
AlertRaisingAlarm()

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
ClearAlertHandler.ClearAlertCode	canClearAlert(Alert alert, AlertState state) Default implementation of ClearAlertHanlder.
abstract Alert	getAlert(AlertState alertState, AlertState previousAlertState) Get the Alert to be raised at the given AlertState.

Methods inherited from class org.lsst.ccs.monitor.Alarm

canClearState, clearState, getName

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.framework.HasLifecycle

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

Constructor Detail

AlertRaisingAlarm

public AlertRaisingAlarm()

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

getAlert

public abstract Alert getAlert(AlertState alertState,
                               AlertState previousAlertState)

Get the Alert to be raised at the given AlertState. The Alarm has been triggered and it's time to raise an Alert. If the provided Alert is null, no alert will be raised.

Parameters:

alertState - The State at which the Alert will be raised.

previousAlertState - The previous state in this state transition.

Returns:

The Alert to be raised.

canClearAlert

public ClearAlertHandler.ClearAlertCode canClearAlert(Alert alert,
                                                      AlertState state)

Default implementation of ClearAlertHanlder.

Specified by:

canClearAlert in interface ClearAlertHandler

Parameters:

alert -

state -

Returns: