org.lsst.ccs.bus.data

Class Alert

java.lang.Object

org.lsst.ccs.bus.data.Alert

All Implemented Interfaces:

Serializable

public final class Alert
extends Object
implements Serializable

Base class for all Alerts. This class provides an alertId field that is used to uniquely identify similar Alert instances: if two Alert instances have the same alertId, they are equal. Alerts are raised when abnormal situations occur, and they can be raised at a different AlertState level. Additionally the Alert class has the following field:

• description: the description of the Alert

Since this class is final it must be used as is by subsystems. This class provides a way to add key-value pairs so that subsystem developers can add subsystem specific information to specific alerts. The values added to the Alert must be basic Serializable object or de-serialization problems will arise in the receiving clients. The Alert data can be provided only at construction time and cannot be modified. When an Alert is raised a StatusAlert message will be published on the Status bus.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Alert(String alertId, String description) Base constructor for all Alerts.
Alert(String alertId, String description, Map<String,Object> innerData) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAlertData(String key, Serializable payload) Add a payload to this Alert.
boolean	equals(Object obj)
Object	getAlertData(String key) Get data contained in this Alert.
Set<String>	getAlertDataNames() Get the Set of names for the Alert data.
String	getAlertId() Get the Alert id
String	getDescription() Get the Alert description
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Alert

public Alert(String alertId,
             String description)

Base constructor for all Alerts.

Parameters:

alertId - The alertId for this Alert instance.

description - The Alert description

Alert

@Deprecated
public Alert(String alertId,
                         String description,
                         Map<String,Object> innerData)

Deprecated.

Base constructor for all Alerts.

Parameters:

alertId - The alertId for this Alert instance.

description - The Alert description

innerData - The Alert data.

Method Detail

getAlertId

public String getAlertId()

Get the Alert id

Returns:

The Alert id

getDescription

public String getDescription()

Get the Alert description

Returns:

The Alert description

getAlertData

public Object getAlertData(String key)

Get data contained in this Alert.

Parameters:

key - The key with which this data was stored.

Returns:

The data for the given key.

addAlertData

public void addAlertData(String key,
                         Serializable payload)

Add a payload to this Alert.

Parameters:

key - The key with which this payload is stored.

payload - The payload to be added.

getAlertDataNames

public Set<String> getAlertDataNames()

Get the Set of names for the Alert data.

Returns:

The Set of Alert data names

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object