org.lsst.ccs.subsystem.ccob.thin

Class Alerts

java.lang.Object

org.lsst.ccs.subsystem.ccob.thin.Alerts

public class Alerts
extends Object

Defines the alerts raised by the subsystem.

Author:

tether

Field Summary

Fields

Modifier and Type	Field and Description
static org.lsst.ccs.bus.data.Alert	COMM_ERROR We raise this alert when the subsystem tried and failed to send a command to TB_Server.
static org.lsst.ccs.bus.data.Alert	INTERNAL_ERROR We raise this alert when none of the other alerts are applicable.
static org.lsst.ccs.bus.data.Alert	SERVER_ERROR We raise this alert when the TB_Server replies to a command with an error or warning message.

Method Summary

Modifier and Type	Method and Description
static void	raiseCommAlert(org.lsst.ccs.services.alert.AlertService al, org.lsst.ccs.drivers.commons.DriverException exc) Raises a comm alert.
static void	raiseInternalAlert(org.lsst.ccs.services.alert.AlertService al, Throwable exc) Raises an internal error alert.
static void	raiseServerAlert(org.lsst.ccs.services.alert.AlertService al, TBServerException exc) Raises a server alert.
static void	registerAllAlerts(org.lsst.ccs.services.alert.AlertService al) Registers all the alerts defined in this class.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_ERROR

public static org.lsst.ccs.bus.data.Alert SERVER_ERROR

We raise this alert when the TB_Server replies to a command with an error or warning message. The cause text we use will be the reply from TB_Server. Since each reply might be different, we'll use the RaiseAlertStrategy ALWAYS.

COMM_ERROR

public static org.lsst.ccs.bus.data.Alert COMM_ERROR

We raise this alert when the subsystem tried and failed to send a command to TB_Server. The cause text we use will be the summary message from the DriverException. Since comm problems may persist for more than a few seconds and since we poll for status every one or two seconds, we'll use the RaiseAlertStrategy ON_SEVERITY_CHANGE.

INTERNAL_ERROR

public static org.lsst.ccs.bus.data.Alert INTERNAL_ERROR

We raise this alert when none of the other alerts are applicable. The cause text we use will be the summary message from the exception. Since this kind of problem will almost certainly not go away without code fixes, we'll use the RaiseAlertStrategy ON_SEVERITY_CHANGE.

Method Detail

registerAllAlerts

public static void registerAllAlerts(org.lsst.ccs.services.alert.AlertService al)

Registers all the alerts defined in this class. For all of them the clear-alert handler is set to AlertService.ALWAYS.

Parameters:

al - an instance of the alert service.

raiseServerAlert

public static void raiseServerAlert(org.lsst.ccs.services.alert.AlertService al,
                                    TBServerException exc)

Raises a server alert.

Parameters:

al - an instance of the alert service.

exc - the exception containing the server's error message.

See Also:

SERVER_ERROR

raiseCommAlert

public static void raiseCommAlert(org.lsst.ccs.services.alert.AlertService al,
                                  org.lsst.ccs.drivers.commons.DriverException exc)

Raises a comm alert.

Parameters:

al - an instance of the alert service.

exc - the exception raised by the comm driver.

See Also:

COMM_ERROR

raiseInternalAlert

public static void raiseInternalAlert(org.lsst.ccs.services.alert.AlertService al,
                                      Throwable exc)

Raises an internal error alert.

Parameters:

al - an instance of the alert service.

exc - the exception raised by the subsystem code or the Java runtime.

See Also:

INTERNAL_ERROR