org.lsst.ccs.gconsole.plugins.alert

Class LsstAlertPlugin

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.plugins.alert.LsstAlertPlugin

@Plugin(name="LSST Alert Notification Plugin",
        id="alert",
        description="LSST CCS alert notification service.")
public class LsstAlertPlugin
extends ConsolePlugin

Graphical console plugin that handles alerts received from CCS subsystems.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LsstAlertPlugin.Descriptor

Constructor Summary

Constructors

Constructor and Description
LsstAlertPlugin()

Method Summary

Modifier and Type	Method and Description
void	clearAlerts(Map<String,String[]> alarms)
void	initialize() Called by the framework when the console starts, to initialize this plugin..
void	onNewAlertTracer()
void	onNewAlertViewer(AlertViewer.Descriptor config)
boolean	restore(ComponentDescriptor storageBean, boolean lastRound) Called by the framework to restore this plugin configuration.
ComponentDescriptor	save() Called by the framework when this plugin configuration needs to be saved.
void	shutdown() Called by the framework when the graphical console is shut down.
void	start() Called by the framework when the console starts, after all plugins have been initialized.
void	stopAlertViewer()

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, propertiesChanged, setServicesProvider, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

LsstAlertPlugin

public LsstAlertPlugin()

Method Detail

initialize

public void initialize()

Description copied from class: ConsolePlugin

Called by the framework when the console starts, to initialize this plugin..

Overrides:

initialize in class ConsolePlugin

start

public void start()

Description copied from class: ConsolePlugin

Called by the framework when the console starts, after all plugins have been initialized. May also be called interactively through the graphical console GUI.

Overrides:

start in class ConsolePlugin

shutdown

public void shutdown()

Description copied from class: ConsolePlugin

Called by the framework when the graphical console is shut down.

Overrides:

shutdown in class ConsolePlugin

onNewAlertViewer

public void onNewAlertViewer(AlertViewer.Descriptor config)

stopAlertViewer

public void stopAlertViewer()

onNewAlertTracer

public void onNewAlertTracer()

clearAlerts

public void clearAlerts(Map<String,String[]> alarms)

save

public ComponentDescriptor save()

Description copied from class: ConsolePlugin

Called by the framework when this plugin configuration needs to be saved.

Overrides:

save in class ConsolePlugin

Returns:

JavaBean that holds information on the current configuration of this plugin.

restore

public boolean restore(ComponentDescriptor storageBean,
                       boolean lastRound)

Description copied from class: ConsolePlugin

Called by the framework to restore this plugin configuration.

Overrides:

restore in class ConsolePlugin

Parameters:

storageBean - JavaBean that holds configuration information.

lastRound - True if this is the last call to this method, regardless of the return value.

Returns:

False if this method should be called again in the next round.