Package org.glassfish.osgi.cli.interactive

Class LocalOSGiShellCommand

java.lang.Object

com.sun.enterprise.admin.cli.CLICommand

org.glassfish.osgi.cli.interactive.LocalOSGiShellCommand

All Implemented Interfaces:

org.glassfish.hk2.api.PostConstruct

@Service(name="osgi-shell")
@PerLookup
public class LocalOSGiShellCommand
extends CLICommand

A simple local asadmin sub-command to establish an interactive osgi shell. This class is forked from com.sun.enterprise.admin.cli.MultimodeCommand Original code authors: केदार(km@dev.java.net) Bill Shannon

Author:

ancoron

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	REMOTE_COMMAND
protected static String	SESSION_OPTION
protected static String	SESSION_OPTION_EXECUTE
protected static String	SESSION_OPTION_START
protected static String	SESSION_OPTION_STOP
protected static String	SESSIONID_OPTION

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
LocalOSGiShellCommand()

Method Summary

Modifier and Type	Method	Description
protected String[]	enhanceForTarget(String[] args)
protected int	executeCommand()	Execute the command using the options in options and the operands in operands.
void	postConstruct()	Initialise the logger after being instantiated by HK2.
protected String[]	prepareArguments(String sessionId, String[] args)
protected String	startSession()
protected int	stopSession(String sessionId)
protected Collection<CommandModel.ParamModel>	usageOptions()	In the usage message modify the --printprompt option to have a default based on the --interactive option.
protected void	validate()	The validate method validates 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, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, setCommandScope, toString

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_COMMAND

protected static final String REMOTE_COMMAND

See Also:

Constant Field Values

SESSIONID_OPTION

protected static final String SESSIONID_OPTION

See Also:

Constant Field Values

SESSION_OPTION

protected static final String SESSION_OPTION

See Also:

Constant Field Values

SESSION_OPTION_EXECUTE

protected static final String SESSION_OPTION_EXECUTE

See Also:

Constant Field Values

SESSION_OPTION_START

protected static final String SESSION_OPTION_START

See Also:

Constant Field Values

SESSION_OPTION_STOP

protected static final String SESSION_OPTION_STOP

See Also:

Constant Field Values

Constructor Detail

LocalOSGiShellCommand

public LocalOSGiShellCommand()

Method Detail

enhanceForTarget

protected String[] enhanceForTarget(String[] args)

prepareArguments

protected String[] prepareArguments(String sessionId,
                                    String[] args)

startSession

protected String startSession()
                       throws CommandException

Throws:

CommandException

stopSession

protected int stopSession(String sessionId)
                   throws CommandException

Throws:

CommandException

validate

protected void validate()
                 throws CommandException,
                        CommandValidationException

The validate method validates that the type and quantity of parameters and operands matches the requirements for this command. The validate method supplies missing options from the environment.

Overrides:

validate in class CLICommand

Throws:

CommandException - if execution of the command fails

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

usageOptions

protected Collection<CommandModel.ParamModel> usageOptions()

In the usage message modify the --printprompt option to have a default based on the --interactive option.

Overrides:

usageOptions in class CLICommand

Returns:

executeCommand

protected 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

postConstruct

public void postConstruct()

Description copied from class: CLICommand

Initialise the logger after being instantiated by HK2.

Specified by:

postConstruct in interface org.glassfish.hk2.api.PostConstruct

Overrides:

postConstruct in class CLICommand