com.sun.enterprise.admin.cli
Class ListCommandsCommand

java.lang.Object
  com.sun.enterprise.admin.cli.CLICommand
      com.sun.enterprise.admin.cli.ListCommandsCommand

All Implemented Interfaces:

org.jvnet.hk2.component.PostConstruct

@Service(name="list-commands")
@Scoped(value=org.jvnet.hk2.component.PerLookup.class)
public class ListCommandsCommand
extends CLICommand

A local list-commands command.

Author:

bnevins, Bill Shannon

Field Summary

private java.util.List<java.lang.String>	cmds
private org.jvnet.hk2.component.Habitat	habitat
private java.lang.String[]	localCommands
private boolean	localOnly
private java.util.List<java.util.regex.Pattern>	patterns
private java.lang.String[]	remoteCommands
private boolean	remoteOnly
private static java.lang.String	SPACES
private static LocalStringsImpl	strings

Fields inherited from class com.sun.enterprise.admin.cli.CLICommand

argv, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, WARNING

Constructor Summary

ListCommandsCommand()

Method Summary

int	executeCommand() Execute the command using the options in options and the operands in operands.
private java.lang.String	globToRegex(java.lang.String line) Convert a shell style glob regular expression to a Java regular expression.
private java.lang.String	justify(java.lang.String s, int width)
private java.lang.String[]	matchCommands(java.lang.String[] commands) Filter the command list to only those matching the patterns.
(package private) void	printLocalCommands()
(package private) void	printRemoteCommands()
protected void	validate() The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.

Methods inherited from class com.sun.enterprise.admin.cli.CLICommand

checkHelp, execute, getBooleanOption, getCommand, getManPage, getName, getOperandModel, getOption, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, ok, parse, postConstruct, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, toString, usageOptions

Methods inherited from class java.lang.Object

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

Field Detail

habitat

private org.jvnet.hk2.component.Habitat habitat

remoteCommands

private java.lang.String[] remoteCommands

localCommands

private java.lang.String[] localCommands

patterns

private java.util.List<java.util.regex.Pattern> patterns

localOnly

private boolean localOnly

remoteOnly

private boolean remoteOnly

cmds

private java.util.List<java.lang.String> cmds

SPACES

private static final java.lang.String SPACES

See Also:

Constant Field Values

strings

private static final LocalStringsImpl strings

Constructor Detail

ListCommandsCommand

public ListCommandsCommand()

Method Detail

validate

protected void validate()
                 throws CommandException,
                        CommandValidationException

Description copied from class: CLICommand

The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.

Overrides:

validate in class CLICommand

Throws:

CommandException - if execution of the command fails

CommandValidationException - if there's something wrong with the options or arguments

executeCommand

public int executeCommand()
                   throws CommandException,
                          CommandValidationException

Description copied from class: CLICommand

Execute the command using the options in options and the operands in operands.

Specified by:

executeCommand in class CLICommand

Returns:

the exit code

Throws:

CommandException - if execution of the command fails

CommandValidationException - if there's something wrong with the options or arguments

matchCommands

private java.lang.String[] matchCommands(java.lang.String[] commands)

Filter the command list to only those matching the patterns.

globToRegex

private java.lang.String globToRegex(java.lang.String line)

Convert a shell style glob regular expression to a Java regular expression. Code from: http://stackoverflow.com/questions/1247772

printLocalCommands

void printLocalCommands()

printRemoteCommands

void printRemoteCommands()

justify

private java.lang.String justify(java.lang.String s,
                                 int width)