@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
| Modifier and Type | Class and Description |
|---|---|
static class |
LsstCommandBrowserPlugin.Descriptor |
| Modifier and Type | Field and Description |
|---|---|
static String[] |
DEFAULT_TYPES |
| Constructor and Description |
|---|
LsstCommandBrowserPlugin() |
| 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(). |
getConsole, getServices, setServicesProvider, shutdownpublic static String[] DEFAULT_TYPES
public void initialize()
ConsolePlugininitialize in class ConsolePluginpublic void start()
ConsolePluginstart in class ConsolePluginpublic void stop()
ConsolePluginConsolePlugin.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.stop in class ConsolePluginpublic void propertiesChanged(Object source, Map<String,Object> changes)
ConsolePluginpropertiesChanged in class ConsolePluginsource - Source of notification.changes - For the changed properties, map of keys to their new values.public void createBrowser(String name, String subsystem)
name - Page title.subsystem - Subsystem name, or null if the page should be able to display commands for all subsystems.public void createBrowser(Browser.Descriptor descriptor)
descriptor - Descriptor of the page to be created.public boolean restore(ComponentDescriptor storageBean, boolean lastRound)
ConsolePluginrestore in class ConsolePluginstorageBean - JavaBean that holds configuration information.lastRound - True if this is the last call to this method, regardless of the return value.False if this method should be called again in the next round.public LsstCommandBrowserPlugin.Descriptor save()
ConsolePluginsave in class ConsolePluginCopyright © 2023 LSST. All rights reserved.