com.redhat.thermostat.common.cli

Interface Command

All Known Implementing Classes:

AgentApplication, BasicCommand, CommandWithInfo, ConnectCommand, DisconnectCommand, DumpHeapCommand, FindObjectsCommand, FindRootCommand, GUIClientCommand, HelpCommand, ListHeapDumpsCommand, ListVMsCommand, ObjectInfoCommand, PingCommand, SaveHeapDumpToFileCommand, ServiceCommand, ShellCommand, ShowHeapHistogramCommand, SimpleCommand, StorageCommand, TestCommand, VMInfoCommand, VMStatCommand

public interface Command

Represents a command on the command line.

To register a custom command, use the CommandRegistry, registering the Commands when the bundle starts and and unregistering them when the bundle stops.

You can also register a custom command by registering it as an OSGi service with the NAME set to the value of getName(). You are responsible for enabling and disabling it at appropriate times then.

See Also:

CommandRegistry

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A short description for the command indicating what it does.
String	getName() Returns a name for this command.
org.apache.commons.cli.Options	getOptions() Returns the Options that the command is prepared to handle.
String	getUsage() How the user should invoke this command
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 (from the main command line).
boolean	isStorageRequired()
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

Throws:

CommandException

getName

String getName()

Returns a name for this command. This will be used by the user to select this command.

getDescription

String getDescription()

A short description for the command indicating what it does.

getUsage

String getUsage()

How the user should invoke this command

getOptions

org.apache.commons.cli.Options getOptions()

Returns the Options that the command is prepared to handle. If the user provides unknown or malformed arguments, this command will not be invoked.

isStorageRequired

boolean isStorageRequired()

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 (from the main command line).

Returns:

true if can command can be invoked from the command line