org.lsst.ccs

Class AlertService

java.lang.Object

org.lsst.ccs.AlertService

All Implemented Interfaces:

HasLifecycle

public final class AlertService
extends Object
implements HasLifecycle

Alert Handling Service.

Author:

LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
AlertService(Agent a)

Method Summary

Modifier and Type	Method and Description
void	addClearAlertHandler(ClearAlertHandler handler) Add a ClearAlertHandler to this Subsystem.
String[]	clearAlerts(String... alertId) Clear one or more Alerts by providing the alert id.
String[]	clearAllAlerts() Attempt to clear all the outstanding alerts.
RaisedAlertSummary	getRaisedAlertSummary() Get the Subsystem's RaisedAlertSummary.
void	postInit() Population of clear alert handlers.
void	postShutdown() Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#shutdown() has been called after shtudownNow has been invoked on all the children.
void	raiseAlert(Alert alert, AlertState severity, String cause) Raise an Alert with a given AlertState.

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

build, init, postBuild, postStart, shutdown, start

Constructor Detail

AlertService

public AlertService(Agent a)

Method Detail

postInit

public void postInit()

Population of clear alert handlers.

Specified by:

postInit in interface HasLifecycle

postShutdown

public void postShutdown()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#shutdown() has been called after shtudownNow has been invoked on all the children. At the time it is called :

• PhaseState is CLOSING.
• HardwareController.checkStopped() has been called

It should be overridden to free non hardware related resources.

Specified by:

postShutdown in interface HasLifecycle

addClearAlertHandler

public void addClearAlertHandler(ClearAlertHandler handler)

Add a ClearAlertHandler to this Subsystem.

Parameters:

handler - The ClearAlertHandler class that will handle the clearing of alerts.

raiseAlert

public void raiseAlert(Alert alert,
                       AlertState severity,
                       String cause)

Raise an Alert with a given AlertState. When an Alert is raised the AlertState of the Agent might change and lock to the value of the AlertState.

Parameters:

alert - The Alert instance to be raised

severity - The AlertState of this Alert.

cause - The reason the Alert was raised.

clearAlerts

@Command(description="Clear alerts",
         type=ACTION)
public String[] clearAlerts(String... alertId)

Clear one or more Alerts by providing the alert id.

Parameters:

alertId - the Id of the Alerts to be cleared.

Returns:

The String array with the ids of the alerts that have been cleared.

clearAllAlerts

@Command(description="Clear all alerts",
         type=ACTION)
public String[] clearAllAlerts()

Attempt to clear all the outstanding alerts.

Returns:

The String array with the ids of the alerts that have been cleared.

getRaisedAlertSummary

@Command(description="Get the Raised Alert Summary",
         type=QUERY)
public RaisedAlertSummary getRaisedAlertSummary()

Get the Subsystem's RaisedAlertSummary.

Returns:

The RaisedAlertSummary for this subsystem.