org.lsst.ccs.gconsole.plugins.alert

Class AlertHandler

java.lang.Object

org.lsst.ccs.gconsole.plugins.alert.AlertHandler

All Implemented Interfaces:

AlertService, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.CommandOriginator, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener

public class AlertHandler
extends Object
implements AlertService, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.messaging.CommandOriginator, org.lsst.ccs.messaging.AgentPresenceListener

Alert handling service implementation.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
AlertHandler(LsstAlertPlugin plugin)

Method Summary

Modifier and Type	Method and Description
void	addListener(AlertListener listener) Adds a listener that will be notified of any future raised or cleared alerts.
void	connecting(org.lsst.ccs.bus.data.AgentInfo agent)
void	disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)
org.lsst.ccs.bus.data.RaisedAlertSummary	getSummary(String source) Returns a summary of alerts from the specified source currently known to this AlertService.
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)
void	processAck(org.lsst.ccs.bus.messages.CommandAck ack)
void	processNack(org.lsst.ccs.bus.messages.CommandNack nack)
void	processResult(org.lsst.ccs.bus.messages.CommandResult result)
void	removeListener(AlertListener listener) Removes an alert listener.
void	submitAlert(String source, org.lsst.ccs.bus.data.Alert alert, org.lsst.ccs.bus.states.AlertState level, String cause) Submits a locally generated alert for processing.

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.gconsole.plugins.alert.AlertService

getHistory

Methods inherited from interface org.lsst.ccs.messaging.AgentPresenceListener

connecting

Constructor Detail

AlertHandler

public AlertHandler(LsstAlertPlugin plugin)

Method Detail

submitAlert

public void submitAlert(String source,
                        org.lsst.ccs.bus.data.Alert alert,
                        org.lsst.ccs.bus.states.AlertState level,
                        String cause)

Description copied from interface: AlertService

Submits a locally generated alert for processing. The alert is not published on the buses but stored by this service and the listeners are notified.

Note that AlertService implementation is responsible for processing alerts published on the buses.

Specified by:

submitAlert in interface AlertService

Parameters:

source - Source of alert (typically the name of the subsystem).

alert - Alert instance.

level - Level at which the alert has been raised.

cause - Information string describing the alert being raised.

onStatusMessage

public void onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.StatusMessageListener

processAck

public void processAck(org.lsst.ccs.bus.messages.CommandAck ack)

Specified by:

processAck in interface org.lsst.ccs.messaging.CommandOriginator

processNack

public void processNack(org.lsst.ccs.bus.messages.CommandNack nack)

Specified by:

processNack in interface org.lsst.ccs.messaging.CommandOriginator

processResult

public void processResult(org.lsst.ccs.bus.messages.CommandResult result)

Specified by:

processResult in interface org.lsst.ccs.messaging.CommandOriginator

connecting

public void connecting(org.lsst.ccs.bus.data.AgentInfo agent)

Specified by:

connecting in interface org.lsst.ccs.messaging.AgentPresenceListener

disconnecting

public void disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)

Specified by:

disconnecting in interface org.lsst.ccs.messaging.AgentPresenceListener

addListener

public void addListener(AlertListener listener)

Description copied from interface: AlertService

Adds a listener that will be notified of any future raised or cleared alerts.

Specified by:

addListener in interface AlertService

Parameters:

listener - Listener to be registered.

removeListener

public void removeListener(AlertListener listener)

Description copied from interface: AlertService

Removes an alert listener.

Specified by:

removeListener in interface AlertService

Parameters:

listener - Listener to be removed.

getSummary

public org.lsst.ccs.bus.data.RaisedAlertSummary getSummary(String source)

Description copied from interface: AlertService

Returns a summary of alerts from the specified source currently known to this AlertService.

Specified by:

getSummary in interface AlertService

Parameters:

source - Alerts source (typically the name of the subsystem).

Returns:

Alerts summary.