org.lsst.ccs.gconsole.base

Class ConsolePlugin

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

Direct Known Subclasses:

AggregatorTest, CommandService, LifeCyclePlugin, LockPlugin, LockService, LsstAlertPlugin, LsstCommandBrowserPlugin, LsstConsolePlugin, LsstJGroupsPlugin, LsstMonitorPlugin, LsstOptionalPageService, LsstRestService, LsstTracerPlugin, LsstTrendingPlugin, OptPageTestPlugin, PersistenceService, RefrigerationPlugin, TestAggregator

public abstract class ConsolePlugin
extends Object

Base class for implementing Graphical Console plugins. Provides life cycle hooks and services that can be used by its subclasses.

To be recognized as a plugin, a subclass should be annotated with @Plugin. The annotation can also be used to provide information about the plugin and some configuration parameters. A subclass should define a default constructor that will be called by the framework to create a singleton instance. The life cycle hooks are initialize(), start(), stop(), and shutdown(). When the graphical console starts, all plugins annotated with loadAtStart=true (default) are loaded, their initialize() methods are called, then their start() methods are called. When the console shuts down, stop() and shutdown() methods are called. In addition, the graphical console might provide a way for the user to call start() and stop() methods interactively.

The services are implemented by forwarding methods calls to the ConsolePluginServices instance set for this plugin by the framework.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
ConsolePlugin()

Method Summary

Modifier and Type	Method and Description
Console	getConsole() Provides access to the graphical console subsystem.
ConsolePluginServices	getServices() Provides access to plugin services.
void	initialize() Called by the framework when the console starts, to initialize this plugin..
void	propertiesChanged(Object source, Map<String,Object> changes) Called by the framework when plugin properties are modified.
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	setServicesProvider(ConsolePluginServices provider) This method is called by the framework to initialize this plugin.
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	stop() Called by the framework when the console shuts down, before the call to shutdown().

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsolePlugin

public ConsolePlugin()

Method Detail

setServicesProvider

public final void setServicesProvider(ConsolePluginServices provider)

This method is called by the framework to initialize this plugin.

Parameters:

provider - ConsolePluginServices to be used by this plugin.

Throws:

UnsupportedOperationException - if called by client code.

initialize

public void initialize()

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

start

public void start()

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

stop

public void stop()

Called by the framework when the console shuts down, before the call to shutdown(). May also be called interactively through the graphical console GUI. In that case, the method will not be called on the console shutdown unless the start() method is invoked again.

shutdown

public void shutdown()

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

propertiesChanged

public void propertiesChanged(Object source,
                              Map<String,Object> changes)

Called by the framework when plugin properties are modified.

Parameters:

source - Source of notification.

changes - For the changed properties, map of keys to their new values.

save

public ComponentDescriptor save()

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

Returns:

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

restore

public boolean restore(ComponentDescriptor storageBean,
                       boolean lastRound)

Called by the framework to restore this plugin configuration.

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.

getConsole

public Console getConsole()

Provides access to the graphical console subsystem.

Returns:

Graphical console subsystem instance.

getServices

public ConsolePluginServices getServices()

Provides access to plugin services.

Returns:

An instance of ConsolePluginServices associated with this plugin.