org.lsst.ccs.gconsole.plugins.commandbrowser

Class LsstCommandBrowserPlugin

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.plugins.commandbrowser.LsstCommandBrowserPlugin

@Plugin(name="LSST Commands Browser Plugin",
        id="command",
        description="LSST Commands Browser allows listing available commands for a subsystem and executing them.",
        shortDescription="LSST Remote Subsystem Commands Browser")
public class LsstCommandBrowserPlugin
extends ConsolePlugin

LSST Command Browser Plugin. The original version of the command dictionary tool was written by Etienne Marin-Matholaz.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LsstCommandBrowserPlugin.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_TYPES

Constructor Summary

Constructors

Constructor and Description
LsstCommandBrowserPlugin()

Method Summary

Modifier and Type	Method and Description
void	createBrowser(Browser.Descriptor descriptor) Creates and displays a command dictionary page customized by the provided descriptor.
void	createBrowser(String name, String subsystem) Creates and displays a generic (un-filtered, default settings) command browser page.
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.
LsstCommandBrowserPlugin.Descriptor	save() Called by the framework when this plugin configuration needs to be saved.
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 ConsolePlugin.shutdown().

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

getConsole, getServices, setServicesProvider, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TYPES

public static String[] DEFAULT_TYPES

Constructor Detail

LsstCommandBrowserPlugin

public LsstCommandBrowserPlugin()

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

stop

public void stop()

Description copied from class: ConsolePlugin

Called by the framework when the console shuts down, before the call to ConsolePlugin.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 ConsolePlugin.start() method is invoked again.

Overrides:

stop in class ConsolePlugin

propertiesChanged

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

Description copied from class: ConsolePlugin

Called by the framework when plugin properties are modified.

Overrides:

propertiesChanged in class ConsolePlugin

Parameters:

source - Source of notification.

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

createBrowser

public void createBrowser(String name,
                          String subsystem)

Creates and displays a generic (un-filtered, default settings) command browser page. May be called on any thread.

Parameters:

name - Page title.

subsystem - Subsystem name, or null if the page should be able to display commands for all subsystems.

createBrowser

public void createBrowser(Browser.Descriptor descriptor)

Creates and displays a command dictionary page customized by the provided descriptor. May be called on any thread.

Parameters:

descriptor - Descriptor of the page to be created.

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.

save

public LsstCommandBrowserPlugin.Descriptor 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.