org.lsst.ccs.gconsole.plugins.alert

Interface AlertService

All Known Implementing Classes:

AlertHandler

public interface AlertService

Alert handling service definition. Instances of classes implementing this interface can be registered with the graphical console lookup.

Author:

onoprien

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.
default org.lsst.ccs.bus.data.RaisedAlertHistory	getHistory(String source, String alertID) Returns the history for the specified alert ID.
org.lsst.ccs.bus.data.RaisedAlertSummary	getSummary(String source) Returns a summary of alerts from the specified source currently known to this AlertService.
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) Submits a locally generated alert for processing.

Method Detail

submitAlert

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

Submits a locally generated alert for processing. Note that AlertService implementation is responsible for processing alerts published on the buses.

Parameters:

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

alert - Alert instance.

level - Level at which the alert has been raised.

addListener

void addListener(AlertListener listener)

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

Parameters:

listener - Listener to be registered.

removeListener

void removeListener(AlertListener listener)

Removes an alert listener.

Parameters:

listener - Listener to be removed.

getSummary

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

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

Parameters:

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

Returns:

Alerts summary.

getHistory

default org.lsst.ccs.bus.data.RaisedAlertHistory getHistory(String source,
                                                            String alertID)

Returns the history for the specified alert ID.

Parameters:

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

alertID - Alert ID.

Returns:

History of alerts.