org.lsst.ccs

Class RaisedAlertBookkeeper

java.lang.Object

org.lsst.ccs.bus.data.RaisedAlertSummary

org.lsst.ccs.RaisedAlertBookkeeper

All Implemented Interfaces:

Serializable

public class RaisedAlertBookkeeper
extends RaisedAlertSummary

Thread-safe modifiable RaisedAlertSummary.

Author:

The LSST CCS Team

See Also:

Serialized Form

Field Summary

Fields inherited from class org.lsst.ccs.bus.data.RaisedAlertSummary

raisedAlerts

Constructor Summary

Constructors

Constructor and Description
RaisedAlertBookkeeper()
RaisedAlertBookkeeper(RaisedAlertSummary summary)

Method Summary

Modifier and Type	Method and Description
void	clearAlert(String alertId) Clear an Alert for the provided alert id.
RaisedAlertHistory	raiseAlert(Alert alert, AlertState severity, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, String cause) Raise an Alert with a given severity at a given CCS timestamp.
RaisedAlertHistory	raiseAlert(Alert alert, AlertState severity, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, String cause, int count) Raise an Alert with a given severity at a given CCS timestamp.
void	setHighestSeverity(String alertId, AlertState highestSeverity) Change the highest severity for a RaisedAlertHistory.

Methods inherited from class org.lsst.ccs.bus.data.RaisedAlertSummary

getAlertState, getAllRaisedAlertHistories, getRaisedAlert, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RaisedAlertBookkeeper

public RaisedAlertBookkeeper()

RaisedAlertBookkeeper

public RaisedAlertBookkeeper(RaisedAlertSummary summary)

Method Detail

raiseAlert

public RaisedAlertHistory raiseAlert(Alert alert,
                                     AlertState severity,
                                     org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp,
                                     String cause)

Raise an Alert with a given severity at a given CCS timestamp. This method will create a RaisedAlert class if needed and update it with the new raised Alert.

Parameters:

alert - The Alert that was raised.

severity - The AlertState of the Alert.

ccsTimeStamp - The CCS timestamp at which the Alert was raised.

cause - What caused the Alert to be raised.

Returns:

The updated RaisedAlert.

raiseAlert

public RaisedAlertHistory raiseAlert(Alert alert,
                                     AlertState severity,
                                     org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp,
                                     String cause,
                                     int count)

Raise an Alert with a given severity at a given CCS timestamp. This method will create a RaisedAlert class if needed and update it with the new raised Alert.

Parameters:

alert - The Alert that was raised.

severity - The AlertState of the Alert.

ccsTimeStamp - The timestamp at which the Alert was raised.

cause - What caused the Alert to be raised.

count - the number of actual raised alerts.

Returns:

The updated RaisedAlert.

clearAlert

public void clearAlert(String alertId)

Clear an Alert for the provided alert id.

Parameters:

alertId - The id of the Alert to clear.

setHighestSeverity

public void setHighestSeverity(String alertId,
                               AlertState highestSeverity)

Change the highest severity for a RaisedAlertHistory.

Parameters:

alertId - The id of the Alert to clear.

highestSeverity - the AlertState the RaisedAlertHistory should be changed to.