org.lsst.ccs.gconsole.plugins.alert

Class AlertEvent

java.lang.Object

java.util.EventObject

org.lsst.ccs.gconsole.plugins.alert.AlertEvent

All Implemented Interfaces:

Serializable

public class AlertEvent
extends EventObject

An event fired by AlertService to notify listeners of raised or cleared alerts.

Author:

onoprien

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AlertEvent(String source, org.lsst.ccs.bus.data.Alert alert, org.lsst.ccs.bus.data.RaisedAlertSummary summary) Constructor for events triggered by a raised alert.
AlertEvent(String source, String[] clearedIDs, org.lsst.ccs.bus.data.RaisedAlertSummary summary) Constructor for events triggered by cleared alerts.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.bus.data.Alert	getAlert() Returns the Alert that triggered this event.
List<String>	getClearedIds() Returns the list of cleared IDs.
org.lsst.ccs.bus.states.AlertState	getLevel() Returns the level (WARNING or ALARM) at which the alert that triggered this event was raised.
String	getSource() Returns the source of the alert that triggered this event.
org.lsst.ccs.bus.data.RaisedAlertSummary	getSummary() Returns the current summary of alerts for the source of the alert that triggered this event.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AlertEvent

public AlertEvent(String source,
                  org.lsst.ccs.bus.data.Alert alert,
                  org.lsst.ccs.bus.data.RaisedAlertSummary summary)

Constructor for events triggered by a raised alert.

Parameters:

source - Alert source (typically, subsystem name).

alert - Alert instance.

summary - Current alert summary for the specified source.

AlertEvent

public AlertEvent(String source,
                  String[] clearedIDs,
                  org.lsst.ccs.bus.data.RaisedAlertSummary summary)

Constructor for events triggered by cleared alerts.

Parameters:

source - Alert source (typically, subsystem name).

clearedIDs - IDs of cleared alerts.

summary - Current alert summary for the specified source.

Method Detail

getSource

public String getSource()

Returns the source of the alert that triggered this event. For alerts received over the buses, this is subsystem name.

Overrides:

getSource in class EventObject

Returns:

the source of the alert.

getAlert

public org.lsst.ccs.bus.data.Alert getAlert()

Returns the Alert that triggered this event. Returns null if this event was triggered by clearing alerts.

Returns:

the Alert that triggered this event.

getLevel

public org.lsst.ccs.bus.states.AlertState getLevel()

Returns the level (WARNING or ALARM) at which the alert that triggered this event was raised. Returns if this event was triggered by clearing alerts.

Returns:

the level at which the alert that triggered this event was raised.

getSummary

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

Returns the current summary of alerts for the source of the alert that triggered this event.

Returns:

the current summary of alerts.

getClearedIds

public List<String> getClearedIds()

Returns the list of cleared IDs. Returns null if this event was not triggered by clearing alerts.

Returns:

the list of cleared IDs.

toString

public String toString()

Overrides:

toString in class EventObject