Package 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.glassfish.hk2.api.PostConstruct

@Service(name="list-commands")
@PerLookup
public class ListCommandsCommand
extends CLICommand

A local list-commands command.

Author:

bnevins, Bill Shannon

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
ListCommandsCommand()

Method Summary

Modifier and Type	Method	Description
int	executeCommand()	Execute the command using the options in options and the operands in operands.
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

buildLineReader, buildTerminal, checkHelp, closeTerminal, execute, execute, expandManPage, getBooleanOption, getBriefCommandUsage, getCommand, getCommand, getCommandScope, getCommandUsage, getManPage, getName, getOperandModel, getOption, getOptions, getPassword, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, newLineReaderBuilder, ok, parse, postConstruct, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, setCommandScope, toString, usageOptions

Methods inherited from class java.lang.Object

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

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