org.lsst.ccs.services.alert

Class AlertEvent

java.lang.Object

java.util.EventObject

org.lsst.ccs.services.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlertEvent.AlertEventType Enumeration of alert event types.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AlertEvent(String source, Alert alert, RaisedAlertSummary summary, AlertEvent.AlertEventType type) Constructor for events triggered by a raised alert.
AlertEvent(String source, String[] clearedIDs, RaisedAlertSummary summary, AlertEvent.AlertEventType type) Constructor for events triggered by cleared alerts.

Method Summary

Modifier and Type	Method and Description
Alert	getAlert() Returns the Alert that triggered this event.
List<String>	getClearedIds() Returns the list of cleared IDs.
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.
AlertState	getStateForClearedAlert(String id) Get the AlertState for the provided alert id.
RaisedAlertSummary	getSummary() Returns the current summary of alerts for the source of the alert that triggered this event.
AlertEvent.AlertEventType	getType() Returns the type of this AlertEvent
boolean	isPartialClear(String id) Check if the Alert for the provided id was partially cleared.
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,
                  Alert alert,
                  RaisedAlertSummary summary,
                  AlertEvent.AlertEventType type)

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.

type - The type of the alert event.

AlertEvent

public AlertEvent(String source,
                  String[] clearedIDs,
                  RaisedAlertSummary summary,
                  AlertEvent.AlertEventType type)

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.

type - The type of the alert event.

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 Alert getAlert()

Returns the Alert that triggered this event. Returns null if this event was triggered by cleared alerts or disconnected agent.

Returns:

the Alert that triggered this event.

getLevel

public AlertState getLevel()

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

Returns:

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

getSummary

public RaisedAlertSummary getSummary()

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

Returns:

the current summary of alerts, or null if the source agent has disconnected from the buses.

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.

getType

public AlertEvent.AlertEventType getType()

Returns the type of this AlertEvent

Returns:

the AlertEventType of this alert event.

toString

public String toString()

Overrides:

toString in class EventObject

isPartialClear

public boolean isPartialClear(String id)

Check if the Alert for the provided id was partially cleared.

Parameters:

id - The Alert id we are checking

Returns:

true if the provided id was partially cleared.

getStateForClearedAlert

public AlertState getStateForClearedAlert(String id)

Get the AlertState for the provided alert id.

Parameters:

id - The Alert id.

Returns:

AlertState.NOMINAL if the alert was fully cleared or the Alert's highest severity (should be WARNING).