com.redhat.thermostat.common.cli

Interface Command

All Known Implementing Classes:

AbstractCommand, AbstractStateNotifyingCommand, AgentApplication, ConnectCommand, DisconnectCommand, DumpHeapCommand, FindObjectsCommand, FindRootCommand, GUIClientCommand, HelpCommand, ListHeapDumpsCommand, ListVMsCommand, ObjectInfoCommand, PingCommand, SaveHeapDumpToFileCommand, ServiceCommand, ShellCommand, ShowHeapHistogramCommand, StorageCommand, VMInfoCommand, VMStatCommand

@ExtensionPoint
public interface Command

Represents a command on the command line.

In order to be runnable, a command must be registered as an OSGi service with the NAME set to the name of the command.

It is also possible to use an instance of CommandRegistry, registering the Commands when the bundle starts and and unregistering them when the bundle stops.

Most Command implementations will want to choose one of the AbstractCommand or AbstractStateNotifyingCommand classes to descend from, as they provide sensible default implementations of most methods and/or provide some other functionality.

See Also:

CommandRegistry, AbstractCommand, AbstractStateNotifyingCommand

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAvailableInShell() Whether the command is available to be invoked from within the shell.
boolean	isAvailableOutsideShell() Indicates if the command is available to be invoked from outside the shell (as an argument to the main thermostat program).
boolean	isStorageRequired() Whether the command depends on Storage
void	run(CommandContext ctx) Execute the command.

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

Method Detail

run

void run(CommandContext ctx)
         throws CommandException

Execute the command. A CommandException may be thrown to indicate a failure condition; if so the com.redhat.thermostat.launcher.Launcher will present the exception message to the user.

Throws:

CommandException

isStorageRequired

boolean isStorageRequired()

Whether the command depends on Storage

Returns:

true if Storage is required.

isAvailableInShell

boolean isAvailableInShell()

Whether the command is available to be invoked from within the shell.

Returns:

true if the command can be invoked from within the shell

isAvailableOutsideShell

boolean isAvailableOutsideShell()

Indicates if the command is available to be invoked from outside the shell (as an argument to the main thermostat program).

Returns:

true if can command can be invoked from the command line