org.lsst.ccs.monitor

Class AlertRaisingAlarm

java.lang.Object

org.lsst.ccs.monitor.Alarm

org.lsst.ccs.monitor.AlertRaisingAlarm

All Implemented Interfaces:

HasLifecycle

public class AlertRaisingAlarm
extends Alarm

An Alarm that raises Alerts rather than notifying AlertHandlers.

Author:

The LSSTCCS Team

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()
AlertRaisingAlarm(Alert alert)

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
protected Alert	getAlert()
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, getAlertStateFromEventId, getName, init

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

postBuild, postInit, postShutdown, postStart, shutdown, start

Constructor Detail

AlertRaisingAlarm

public AlertRaisingAlarm()

AlertRaisingAlarm

public AlertRaisingAlarm(Alert alert)

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.

getAlert

public 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.

getAlert

protected Alert getAlert()

Overrides:

getAlert in class Alarm