CommandContextImpl (WildFly: Command line interface 6.0.0.CR3 API)

java.lang.Object
- org.jboss.as.cli.impl.CommandContextImpl

All Implemented Interfaces:: CommandContext, ModelControllerClientFactory.ConnectionCloseHandler

public class CommandContextImpl
extends Object
implements CommandContext, ModelControllerClientFactory.ConnectionCloseHandler

Author:: Alexey Loubyansky

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jboss.as.cli.CommandContext
  CommandContext.Scope, CommandContext.TIMEOUT_RESET_VALUE

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEventListener(CliEventListener listener)` Adds a listener for CLI events.
`protected void`	`addShutdownHook()`
`void`	`bindClient(ModelControllerClient newClient)` Bind the controller to an existing, connected client.
`OperationCommand.HandledRequest`	`buildAeshCommandRequest(ParsedCommandLine parsedCmd, boolean batchMode)`
`org.jboss.dmr.ModelNode`	`buildRequest(String line)` Builds a DMR request corresponding to the command or the operation.
`protected OperationCommand.HandledRequest`	`buildRequest(String line, boolean batchMode)`
`void`	`captureOutput(PrintStream captor)` Redirect output to the given print stream.
`void`	`clear(CommandContext.Scope scope)` Clear the content of a scope.
`void`	`clearScreen()` Clears the screen.
`void`	`connectController()` Connects the controller client using the default controller definition.
`void`	`connectController(String controller)` Connects to the controller specified.
`void`	`connectController(String host, int port)` Deprecated.
`void`	`connectController(String controller, String clientAddress)` Connects to the controller specified.
`void`	`disconnectController()` Closes the previously established connection with the controller client.
`protected void`	`error(String message)` Set the exit code of the process to indicate an error and output the error message.
`org.jboss.dmr.ModelNode`	`execute(org.jboss.dmr.ModelNode mn, String description)` Execute an operation.
`org.jboss.dmr.ModelNode`	`execute(Operation mn, String description)` Execute an operation.
`Object`	`get(CommandContext.Scope scope, String key)` Returns the value the key was associated with using the set(key, value) method above.
`AeshCommands`	`getAeshCommands()`
`String`	`getArgumentsString()` Returns the current command's arguments as a string.
`BatchManager`	`getBatchManager()` Returns batch manager.
`CommandLineParser`	`getCommandLineParser()` Returns the current operation request parser.
`int`	`getCommandTimeout()` Returns the command execution timeout value.
`CliConfig`	`getConfig()` Returns the JBoss CLI configuration.
`ConnectionInfo`	`getConnectionInfo()` The ConnectionInfo bean is set after the connection is established to the server.
`ReadlineConsole`	`getConsole()` Public for testing purpose only.
`String`	`getControllerHost()` Returns the host the controller client is connected to or null if the connection hasn't been established yet.
`int`	`getControllerPort()` Returns the port the controller client is connected to.
`File`	`getCurrentDir()` Returns current default filesystem directory.
`OperationRequestAddress`	`getCurrentNodePath()` Returns the current prefix.
`CommandLineCompleter`	`getDefaultCommandCompleter()` Returns the default command line completer.
`ControllerAddress`	`getDefaultControllerAddress()` The default address of the default controller to connect to.
`String`	`getDefaultControllerHost()` Deprecated.
`int`	`getDefaultControllerPort()` Deprecated.
`int`	`getExitCode()` Returns value that should be used as the exit code of the JVM process.
`CommandHistory`	`getHistory()` Returns the history of all the commands and operations.
`CLICommandCompleter.Completer`	`getLegacyCommandCompleter()`
`ModelControllerClient`	`getModelControllerClient()` Returns the model controller client or null if it hasn't been initialized.
`NodePathFormatter`	`getNodePathFormatter()` Returns the prefix formatter.
`OperationCandidatesProvider`	`getOperationCandidatesProvider()` Returns the provider of operation request candidates for tab-completion.
`ParsedCommandLine`	`getParsedCommandLine()` Parsed command line arguments.
`int`	`getTerminalHeight()` Returns the current terminal window height in case the console has been initialized.
`int`	`getTerminalWidth()` Returns the current terminal window width in case the console has been initialized.
`String`	`getVariable(String name)` Returns the value for the variable.
`Collection<String>`	`getVariables()` Returns a collection of all the defined variable names.
`void`	`handle(String line)` Executes a command or an operation.
`void`	`handleClose()`
`void`	`handleSafe(String line)` Executes a command or an operation.
`protected void`	`initBasicConsole(InputStream consoleInput)`
`protected void`	`initBasicConsole(InputStream consoleInput, boolean start)`
`int[]`	`input()`
`String`	`input(org.aesh.readline.Prompt prompt)`
`String`	`input(String prompt, boolean password)`
`void`	`interact()` This method will start an interactive session.
`protected void`	`interactionDisabled()`
`boolean`	`isBatchMode()` Checks whether the CLI is in the batch mode.
`boolean`	`isColorOutput()`
`boolean`	`isDomainMode()` Indicates whether the CLI is in the domain mode or standalone one (assuming established connection to the controller).
`boolean`	`isResolveParameterValues()` Command argument or operation parameter values may contain system properties.
`boolean`	`isSilent()` Whether the info or error messages should be written to the terminal output.
`boolean`	`isTerminated()` Checks whether the session has been terminated.
`boolean`	`isWorkflowMode()` Checks whether the CLI is in a workflow mode.
`CommandContext`	`newTimeoutCommandContext()`
`protected void`	`notifyListeners(CliEvent event)`
`void`	`print(String message)` Prints a string to the CLI's output.
`void`	`print(String message, boolean newLine, boolean collect)`
`void`	`printColumns(Collection<String> col)` Prints a collection of strings as columns to the CLI's output.
`void`	`printDMR(org.jboss.dmr.ModelNode node, boolean compact)` Prints a ModelNode according to the current configuration.
`void`	`printLine(String message)` Prints a string to the CLI's output.
`void`	`printLine(String message, String outcome)`
`void`	`registerRedirection(CommandLineRedirection redirection)` After this method returns command line handling will be redirected to the passed in CommandLineRedirection instance.
`void`	`releaseOutput()` Stops redirecting output to the stream passed to `CommandContext.captureOutput(java.io.PrintStream)`.
`Object`	`remove(CommandContext.Scope scope, String key)` Removes the value the key was associated with using the set(key, value) method above.
`void`	`resetTimeout(CommandContext.TIMEOUT_RESET_VALUE value)` Reset the timeout value.
`void`	`set(CommandContext.Scope scope, String key, Object value)` Associates an object with key.
`void`	`setCommandTimeout(int numSeconds)` Set the command timeout to a number of seconds.
`void`	`setCurrentDir(File dir)` Changes the current default filesystem directory to the argument.
`void`	`setResolveParameterValues(boolean resolve)` Command argument or operation parameter values may contain system properties.
`void`	`setSilent(boolean silent)` Enables of disables the silent mode.
`void`	`setVariable(String name, String value)` Initializes a variable with the given name with the given value.
`void`	`terminateSession()` Terminates the command line session.
`BatchedCommand`	`toBatchedCommand(String line)` Builds an operation request from the passed in command line.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.as.cli.CommandContext
get, printDMR, remove, set

- Method Detail
  - addShutdownHook
```
protected void addShutdownHook()
```
  - initBasicConsole
```
protected void initBasicConsole(InputStream consoleInput)
                         throws CliInitializationException
```
    Throws:
    
    CliInitializationException
  - initBasicConsole
```
protected void initBasicConsole(InputStream consoleInput,
                                boolean start)
                         throws CliInitializationException
```
    Throws:
    
    CliInitializationException
  - getExitCode
```
public int getExitCode()
```
    Description copied from interface: CommandContext
    
    Returns value that should be used as the exit code of the JVM process.
    
    Specified by:
    
    getExitCode in interface CommandContext
    
    Returns:
    
    JVM exit code
  - isTerminated
```
public boolean isTerminated()
```
    Description copied from interface: CommandContext
    
    Checks whether the session has been terminated.
    
    Specified by:
    
    isTerminated in interface CommandContext
    
    Returns:
  - handle
```
public void handle(String line)
            throws CommandLineException
```
    Description copied from interface: CommandContext
    
    Executes a command or an operation. Or, if the context is in the batch mode and the command is allowed in the batch, adds the command (or the operation) to the currently active batch. NOTE: errors are not handled by this method, they won't affect the exit code or even be logged. Error handling is the responsibility of the caller.
    
    Specified by:
    
    handle in interface CommandContext
    
    Parameters:
    
    line - command or operation to handle
    
    Throws:
    
    CommandFormatException - in case there was an error handling the command or operation
    
    CommandLineException
  - execute
```
public org.jboss.dmr.ModelNode execute(Operation mn,
                                       String description)
                                throws CommandLineException,
                                       IOException
```
    Description copied from interface: CommandContext
    
    Execute an operation. This call is guarded by the command timeout.
    
    Specified by:
    
    execute in interface CommandContext
    
    Parameters:
    
    mn - The operation.
    
    description - Operation description, used in exception message.
    
    Returns:
    
    The response.
    
    Throws:
    
    CommandLineException - If an exception occurs.
    
    IOException - If an IOException occurs.
  - execute
```
public org.jboss.dmr.ModelNode execute(org.jboss.dmr.ModelNode mn,
                                       String description)
                                throws CommandLineException,
                                       IOException
```
    Description copied from interface: CommandContext
    
    Execute an operation. This call is guarded by the command timeout.
    
    Specified by:
    
    execute in interface CommandContext
    
    Parameters:
    
    mn - The operation.
    
    description - Operation description, used in exception message.
    
    Returns:
    
    The response.
    
    Throws:
    
    CommandLineException - If an exception occurs.
    
    IOException - If an IOException occurs.
  - handleSafe
```
public void handleSafe(String line)
```
    Description copied from interface: CommandContext
    
    Executes a command or an operation. Or, if the context is in the batch mode and the command is allowed in the batch, adds the command (or the operation) to the currently active batch. NOTE: unlike handle(String line), this method catches CommandLineException exceptions thrown by command handlers, logs them and sets the exit code status to indicate that the command or the operation has failed. It's up to the caller to check the exit code with getExitCode() to find out whether the command or the operation succeeded or failed.
    
    Specified by:
    
    handleSafe in interface CommandContext
    
    Parameters:
    
    line - command or operation to handle
  - getArgumentsString
```
public String getArgumentsString()
```
    Description copied from interface: CommandContext
    
    Returns the current command's arguments as a string.
    
    Specified by:
    
    getArgumentsString in interface CommandContext
    
    Returns:
    
    current command's arguments as a string or null if the command was entered w/o arguments.
  - terminateSession
```
public void terminateSession()
```
    Description copied from interface: CommandContext
    
    Terminates the command line session. Also closes the connection to the controller if it's still open.
    
    Specified by:
    
    terminateSession in interface CommandContext
  - print
```
public void print(String message,
                  boolean newLine,
                  boolean collect)
```
  - printDMR
```
public void printDMR(org.jboss.dmr.ModelNode node,
                     boolean compact)
```
    Description copied from interface: CommandContext
    
    Prints a ModelNode according to the current configuration.
    
    Specified by:
    
    printDMR in interface CommandContext
    
    Parameters:
    
    node - The ModelNode to print.
    
    compact - true for content displayed onto a single line.
  - isColorOutput
```
public final boolean isColorOutput()
```
  - printLine
```
public void printLine(String message)
```
    Description copied from interface: CommandContext
    
    Prints a string to the CLI's output. Terminates the message by writing the line separator string.
    
    Specified by:
    
    printLine in interface CommandContext
    
    Parameters:
    
    message - the message to print
  - printLine
```
public void printLine(String message,
                      String outcome)
```
  - print
```
public void print(String message)
```
    Description copied from interface: CommandContext
    
    Prints a string to the CLI's output.
    
    Specified by:
    
    print in interface CommandContext
    
    Parameters:
    
    message - the message to print
  - error
```
protected void error(String message)
```
    Set the exit code of the process to indicate an error and output the error message. WARNING This method should only be called for unrecoverable errors as once the exit code is set subsequent operations may not be possible.
    
    Parameters:
    
    message - The message to display.
  - input
```
public String input(String prompt,
                    boolean password)
             throws CommandLineException,
                    InterruptedException,
                    IOException
```
    Throws:
    
    CommandLineException
    
    InterruptedException
    
    IOException
  - input
```
public String input(org.aesh.readline.Prompt prompt)
             throws CommandLineException,
                    InterruptedException,
                    IOException
```
    Throws:
    
    CommandLineException
    
    InterruptedException
    
    IOException
  - input
```
public int[] input()
            throws CommandLineException,
                   InterruptedException,
                   IOException
```
    Throws:
    
    CommandLineException
    
    InterruptedException
    
    IOException
  - interactionDisabled
```
protected void interactionDisabled()
                            throws CommandLineException
```
    Throws:
    
    CommandLineException
  - printColumns
```
public void printColumns(Collection<String> col)
```
    Description copied from interface: CommandContext
    
    Prints a collection of strings as columns to the CLI's output.
    
    Specified by:
    
    printColumns in interface CommandContext
    
    Parameters:
    
    col - the collection of strings to print as columns.
  - set
```
public void set(CommandContext.Scope scope,
                String key,
                Object value)
```
    Description copied from interface: CommandContext
    
    Associates an object with key. The mapping is valid until this method is called with the same key value and null as the new value for this key.
    
    Specified by:
    
    set in interface CommandContext
    
    Parameters:
    
    scope - Entry duration scope
    
    key - the key
    
    value - the value to be associated with the key
  - get
```
public Object get(CommandContext.Scope scope,
                  String key)
```
    Description copied from interface: CommandContext
    
    Returns the value the key was associated with using the set(key, value) method above.
    
    Specified by:
    
    get in interface CommandContext
    
    Parameters:
    
    scope - Entry duration scope
    
    key - the key to fetch the value for
    
    Returns:
    
    the value associated with the key or null, if the key wasn't associated with any non-null value.
  - clear
```
public void clear(CommandContext.Scope scope)
```
    Description copied from interface: CommandContext
    
    Clear the content of a scope.
    
    Specified by:
    
    clear in interface CommandContext
    
    Parameters:
    
    scope - The scope to clear, can't be null.
  - remove
```
public Object remove(CommandContext.Scope scope,
                     String key)
```
    Description copied from interface: CommandContext
    
    Removes the value the key was associated with using the set(key, value) method above. If the key isn't associated with any value, the method will return null.
    
    Specified by:
    
    remove in interface CommandContext
    
    Parameters:
    
    scope - The entry duration scope
    
    key - the key to be removed
    
    Returns:
    
    the value associated with the key or null, if the key wasn't associated with any non-null value.
  - getModelControllerClient
```
public ModelControllerClient getModelControllerClient()
```
    Description copied from interface: CommandContext
    
    Returns the model controller client or null if it hasn't been initialized.
    
    Specified by:
    
    getModelControllerClient in interface CommandContext
    
    Returns:
    
    the model controller client or null if it hasn't been initialized.
  - getCommandLineParser
```
public CommandLineParser getCommandLineParser()
```
    Description copied from interface: CommandContext
    
    Returns the current operation request parser.
    
    Specified by:
    
    getCommandLineParser in interface CommandContext
    
    Returns:
    
    current operation request parser.
  - getCurrentNodePath
```
public OperationRequestAddress getCurrentNodePath()
```
    Description copied from interface: CommandContext
    
    Returns the current prefix.
    
    Specified by:
    
    getCurrentNodePath in interface CommandContext
    
    Returns:
    
    current prefix
  - getNodePathFormatter
```
public NodePathFormatter getNodePathFormatter()
```
    Description copied from interface: CommandContext
    
    Returns the prefix formatter.
    
    Specified by:
    
    getNodePathFormatter in interface CommandContext
    
    Returns:
    
    the prefix formatter.
  - getOperationCandidatesProvider
```
public OperationCandidatesProvider getOperationCandidatesProvider()
```
    Description copied from interface: CommandContext
    
    Returns the provider of operation request candidates for tab-completion.
    
    Specified by:
    
    getOperationCandidatesProvider in interface CommandContext
    
    Returns:
    
    provider of operation request candidates for tab-completion.
  - connectController
```
public void connectController()
                       throws CommandLineException
```
    Description copied from interface: CommandContext
    
    Connects the controller client using the default controller definition. The default controller will be identified as the default specified on starting the CLI will be used, if no controller was specified on start up then the default defined in the CLI configuration will be used, if no default is defined then a connection to remote+http://localhost:9990 will be used instead.
    
    Specified by:
    
    connectController in interface CommandContext
    
    Throws:
    
    CommandLineException - in case the attempt to connect failed
  - connectController
```
public void connectController(String controller)
                       throws CommandLineException
```
    Description copied from interface: CommandContext
    
    Connects to the controller specified. If the controller is null then the default specified on starting the CLI will be used, if no controller was specified on start up then the default defined in the CLI configuration will be used, if no default is defined then a connection to remote+http://localhost:9990 will be used instead.
    
    Specified by:
    
    connectController in interface CommandContext
    
    Parameters:
    
    controller - the controller to connect to
    
    Throws:
    
    CommandLineException - in case the attempt to connect failed
  - connectController
```
public void connectController(String controller,
                              String clientAddress)
                       throws CommandLineException
```
    Description copied from interface: CommandContext
    
    Connects to the controller specified. If the controller is null then the default specified on starting the CLI will be used, if no controller was specified on start up then the default defined in the CLI configuration will be used, if no default is defined then a connection to remote+http://localhost:9990 will be used instead.
    
    Specified by:
    
    connectController in interface CommandContext
    
    Parameters:
    
    controller - the controller to connect to
    
    clientAddress - the address the client will bind to
    
    Throws:
    
    CommandLineException - in case the attempt to connect failed
  - connectController
```
@Deprecated
public void connectController(String host,
                                          int port)
                                   throws CommandLineException
```
    Deprecated.
    
    Description copied from interface: CommandContext
    
    Connects the controller client using the host and the port. If the host is null, the default controller host will be used, which is localhost. If the port is less than zero, the default controller port will be used, which is 9999.
    
    Specified by:
    
    connectController in interface CommandContext
    
    Parameters:
    
    host - the host to connect with
    
    port - the port to connect on
    
    Throws:
    
    CommandLineException - in case the attempt to connect failed
  - bindClient
```
public void bindClient(ModelControllerClient newClient)
```
    Description copied from interface: CommandContext
    
    Bind the controller to an existing, connected client.
    
    Specified by:
    
    bindClient in interface CommandContext
  - getCurrentDir
```
public File getCurrentDir()
```
    Description copied from interface: CommandContext
    
    Returns current default filesystem directory.
    
    Specified by:
    
    getCurrentDir in interface CommandContext
    
    Returns:
    
    current default filesystem directory.
  - setCurrentDir
```
public void setCurrentDir(File dir)
```
    Description copied from interface: CommandContext
    
    Changes the current default filesystem directory to the argument.
    
    Specified by:
    
    setCurrentDir in interface CommandContext
    
    Parameters:
    
    dir - the new default directory
  - registerRedirection
```
public void registerRedirection(CommandLineRedirection redirection)
                         throws CommandLineException
```
    Description copied from interface: CommandContext
    
    After this method returns command line handling will be redirected to the passed in CommandLineRedirection instance.
    
    Specified by:
    
    registerRedirection in interface CommandContext
    
    Parameters:
    
    redirection - command line redirection handler
    
    Throws:
    
    CommandLineException - in case registration fails (e.g. in case one has already been registered
  - disconnectController
```
public void disconnectController()
```
    Description copied from interface: CommandContext
    
    Closes the previously established connection with the controller client. If the connection hasn't been established, the method silently returns.
    
    Specified by:
    
    disconnectController in interface CommandContext
  - getDefaultControllerHost
```
@Deprecated
public String getDefaultControllerHost()
```
    Deprecated.
    
    Description copied from interface: CommandContext
    
    Returns the default host the controller client will be connected to.
    
    Specified by:
    
    getDefaultControllerHost in interface CommandContext
    
    Returns:
    
    the default host the controller client will be connected to.
  - getDefaultControllerPort
```
@Deprecated
public int getDefaultControllerPort()
```
    Deprecated.
    
    Description copied from interface: CommandContext
    
    Returns the default port the controller client will be connected to.
    
    Specified by:
    
    getDefaultControllerPort in interface CommandContext
    
    Returns:
    
    the default port the controller client will be connected to.
  - getDefaultControllerAddress
```
public ControllerAddress getDefaultControllerAddress()
```
    Description copied from interface: CommandContext
    
    The default address of the default controller to connect to.
    
    Specified by:
    
    getDefaultControllerAddress in interface CommandContext
    
    Returns:
    
    The default address.
  - getControllerHost
```
public String getControllerHost()
```
    Description copied from interface: CommandContext
    
    Returns the host the controller client is connected to or null if the connection hasn't been established yet.
    
    Specified by:
    
    getControllerHost in interface CommandContext
    
    Returns:
    
    the host the controller client is connected to or null if the connection hasn't been established yet.
  - getControllerPort
```
public int getControllerPort()
```
    Description copied from interface: CommandContext
    
    Returns the port the controller client is connected to.
    
    Specified by:
    
    getControllerPort in interface CommandContext
    
    Returns:
    
    the port the controller client is connected to.
  - clearScreen
```
public void clearScreen()
```
    Description copied from interface: CommandContext
    
    Clears the screen.
    
    Specified by:
    
    clearScreen in interface CommandContext
  - getHistory
```
public CommandHistory getHistory()
```
    Description copied from interface: CommandContext
    
    Returns the history of all the commands and operations.
    
    Specified by:
    
    getHistory in interface CommandContext
    
    Returns:
    
    the history of all the commands and operations.
  - isBatchMode
```
public boolean isBatchMode()
```
    Description copied from interface: CommandContext
    
    Checks whether the CLI is in the batch mode.
    
    Specified by:
    
    isBatchMode in interface CommandContext
    
    Returns:
    
    true if the CLI is in the batch mode, false - otherwise.
  - isWorkflowMode
```
public boolean isWorkflowMode()
```
    Description copied from interface: CommandContext
    
    Checks whether the CLI is in a workflow mode.
    
    Specified by:
    
    isWorkflowMode in interface CommandContext
    
    Returns:
    
    true if the CLI is in a workflow mode, false - otherwise.
  - getBatchManager
```
public BatchManager getBatchManager()
```
    Description copied from interface: CommandContext
    
    Returns batch manager.
    
    Specified by:
    
    getBatchManager in interface CommandContext
    
    Returns:
    
    batch manager
  - toBatchedCommand
```
public BatchedCommand toBatchedCommand(String line)
                                throws CommandFormatException
```
    Description copied from interface: CommandContext
    
    Builds an operation request from the passed in command line. If the line contains a command, the command must supported the batch mode, otherwise an exception will thrown.
    
    Specified by:
    
    toBatchedCommand in interface CommandContext
    
    Parameters:
    
    line - the command line which can be an operation request or a command that can be translated into an operation request.
    
    Returns:
    
    the operation request
    
    Throws:
    
    CommandFormatException - if the operation request couldn't be built.
  - buildRequest
```
public org.jboss.dmr.ModelNode buildRequest(String line)
                                     throws CommandFormatException
```
    Description copied from interface: CommandContext
    
    Builds a DMR request corresponding to the command or the operation. If the line contains a command, the corresponding command handler must implement org.jboss.cli.OperationCommand interface, in other words the command must translate into an operation request, otherwise an exception will be thrown.
    
    Specified by:
    
    buildRequest in interface CommandContext
    
    Parameters:
    
    line - command or an operation to build a DMR request for
    
    Returns:
    
    DMR request corresponding to the line
    
    Throws:
    
    CommandFormatException - thrown in case the line couldn't be translated into a DMR request
  - buildRequest
```
protected OperationCommand.HandledRequest buildRequest(String line,
                                                       boolean batchMode)
                                                throws CommandFormatException
```
    Throws:
    
    CommandFormatException
  - buildAeshCommandRequest
```
public OperationCommand.HandledRequest buildAeshCommandRequest(ParsedCommandLine parsedCmd,
                                                               boolean batchMode)
                                                        throws CommandFormatException
```
    Throws:
    
    CommandFormatException
  - getDefaultCommandCompleter
```
public CommandLineCompleter getDefaultCommandCompleter()
```
    Description copied from interface: CommandContext
    
    Returns the default command line completer.
    
    Specified by:
    
    getDefaultCommandCompleter in interface CommandContext
    
    Returns:
    
    the default command line completer.
  - getParsedCommandLine
```
public ParsedCommandLine getParsedCommandLine()
```
    Description copied from interface: CommandContext
    
    Parsed command line arguments.
    
    Specified by:
    
    getParsedCommandLine in interface CommandContext
    
    Returns:
    
    parsed command line arguments.
  - isDomainMode
```
public boolean isDomainMode()
```
    Description copied from interface: CommandContext
    
    Indicates whether the CLI is in the domain mode or standalone one (assuming established connection to the controller).
    
    Specified by:
    
    isDomainMode in interface CommandContext
    
    Returns:
    
    true if the CLI is connected to the domain controller, otherwise false.
  - addEventListener
```
public void addEventListener(CliEventListener listener)
```
    Description copied from interface: CommandContext
    
    Adds a listener for CLI events.
    
    Specified by:
    
    addEventListener in interface CommandContext
    
    Parameters:
    
    listener - the listener
  - getConfig
```
public CliConfig getConfig()
```
    Description copied from interface: CommandContext
    
    Returns the JBoss CLI configuration.
    
    Specified by:
    
    getConfig in interface CommandContext
    
    Returns:
    
    CLI configuration
  - notifyListeners
```
protected void notifyListeners(CliEvent event)
```
  - interact
```
public void interact()
```
    Description copied from interface: CommandContext
    
    This method will start an interactive session. It requires an initialized at the construction time console.
    
    Specified by:
    
    interact in interface CommandContext
  - isResolveParameterValues
```
public boolean isResolveParameterValues()
```
    Description copied from interface: CommandContext
    
    Command argument or operation parameter values may contain system properties. If this method returns true then the CLI will try to resolve the system properties before sending the operation request to the controller. Otherwise, the resolution will happen on the server side.
    
    Specified by:
    
    isResolveParameterValues in interface CommandContext
    
    Returns:
    
    true if system properties in the operation parameter values should be resolved by the CLI before the request is sent to the controller, false if system properties should be resolved on the server side.
  - setResolveParameterValues
```
public void setResolveParameterValues(boolean resolve)
```
    Description copied from interface: CommandContext
    
    Command argument or operation parameter values may contain system properties. If this property is set to true then the CLI will try to resolve the system properties before sending the operation request to the controller. Otherwise, the resolution will happen on the server side.
    
    Specified by:
    
    setResolveParameterValues in interface CommandContext
    
    Parameters:
    
    resolve - true if system properties in the operation parameter values should be resolved by the CLI before the request is sent to the controller, false if system properties should be resolved on the server side.
  - handleClose
```
public void handleClose()
```
    Specified by:
    
    handleClose in interface ModelControllerClientFactory.ConnectionCloseHandler
  - isSilent
```
public boolean isSilent()
```
    Description copied from interface: CommandContext
    
    Whether the info or error messages should be written to the terminal output. The output of the info and error messages is done in the following way: 1) the message is always logged using a logger (which is disabled in the config by default); 2) if the output target was specified on the command line using '>' it would be used; 3) if the output target was not specified, whether the message is written or not to the terminal output will depend on whether it's a silent mode or not.
    
    Specified by:
    
    isSilent in interface CommandContext
    
    Returns:
    
    true if the CLI is in the silent mode, i.e. not writing info and error messages to the terminal output, otherwise - false.
  - setSilent
```
public void setSilent(boolean silent)
```
    Description copied from interface: CommandContext
    
    Enables of disables the silent mode.
    
    Specified by:
    
    setSilent in interface CommandContext
    
    Parameters:
    
    silent - true if the CLI should go into the silent mode, false if the CLI should resume writing info and error messages to the terminal output.
  - getTerminalWidth
```
public int getTerminalWidth()
```
    Description copied from interface: CommandContext
    
    Returns the current terminal window width in case the console has been initialized. Otherwise -1.
    
    Specified by:
    
    getTerminalWidth in interface CommandContext
    
    Returns:
    
    current terminal with if the console has been initialized, -1 otherwise
  - getTerminalHeight
```
public int getTerminalHeight()
```
    Description copied from interface: CommandContext
    
    Returns the current terminal window height in case the console has been initialized. Otherwise -1.
    
    Specified by:
    
    getTerminalHeight in interface CommandContext
    
    Returns:
    
    current terminal height if the console has been initialized, -1 otherwise
  - setVariable
```
public void setVariable(String name,
                        String value)
                 throws CommandLineException
```
    Description copied from interface: CommandContext
    
    Initializes a variable with the given name with the given value. The name of the variable must follow the rules for Java identifiers but not contain '$' character. If the variable already exists, its value will be silently overridden. Passing in null as the value will remove the variable altogether. If the variable with the given name has not been defined and the value passed in is null, the method will return silently.
    
    Specified by:
    
    setVariable in interface CommandContext
    
    Parameters:
    
    name - name of the variable
    
    value - value for the variable
    
    Throws:
    
    CommandLineException - in case the name contains illegal characters
  - getVariable
```
public String getVariable(String name)
```
    Description copied from interface: CommandContext
    
    Returns the value for the variable. If the variable has not been defined the method will return null.
    
    Specified by:
    
    getVariable in interface CommandContext
    
    Parameters:
    
    name - name of the variable
    
    Returns:
    
    the value of the variable or null if the variable has not been defined
  - getVariables
```
public Collection<String> getVariables()
```
    Description copied from interface: CommandContext
    
    Returns a collection of all the defined variable names. If there no variables defined, an empty collection will be returned.
    
    Specified by:
    
    getVariables in interface CommandContext
    
    Returns:
    
    collection of all the defined variable names or an empty collection if no variables has been defined
  - getConnectionInfo
```
public ConnectionInfo getConnectionInfo()
```
    Description copied from interface: CommandContext
    
    The ConnectionInfo bean is set after the connection is established to the server.
    
    Specified by:
    
    getConnectionInfo in interface CommandContext
    
    Returns:
    
    information about the current connection to the server.
  - captureOutput
```
public void captureOutput(PrintStream captor)
```
    Description copied from interface: CommandContext
    
    Redirect output to the given print stream.
    
    Specified by:
    
    captureOutput in interface CommandContext
    
    Parameters:
    
    captor - stream to which output should be written. Cannot be null
  - releaseOutput
```
public void releaseOutput()
```
    Description copied from interface: CommandContext
    
    Stops redirecting output to the stream passed to CommandContext.captureOutput(java.io.PrintStream).
    
    Specified by:
    
    releaseOutput in interface CommandContext
  - setCommandTimeout
```
public final void setCommandTimeout(int numSeconds)
```
    Description copied from interface: CommandContext
    
    Set the command timeout to a number of seconds. Value equals to 0 means no timeout.
    
    Specified by:
    
    setCommandTimeout in interface CommandContext
    
    Parameters:
    
    numSeconds - The timeout value.
  - getCommandTimeout
```
public final int getCommandTimeout()
```
    Description copied from interface: CommandContext
    
    Returns the command execution timeout value. Value equals to 0 means no timeout.
    
    Specified by:
    
    getCommandTimeout in interface CommandContext
    
    Returns:
    
    The timeout value.
  - resetTimeout
```
public final void resetTimeout(CommandContext.TIMEOUT_RESET_VALUE value)
```
    Description copied from interface: CommandContext
    
    Reset the timeout value.
    
    Specified by:
    
    resetTimeout in interface CommandContext
    
    Parameters:
    
    value - The enumerated timeout reset value.
  - getConsole
```
public ReadlineConsole getConsole()
```
    Public for testing purpose only.
    
    Returns:
  - getAeshCommands
```
public AeshCommands getAeshCommands()
```
  - getLegacyCommandCompleter
```
public CLICommandCompleter.Completer getLegacyCommandCompleter()
```
  - newTimeoutCommandContext
```
public CommandContext newTimeoutCommandContext()
```

Class CommandContextImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.cli.CommandContext

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jboss.as.cli.CommandContext

Method Detail

addShutdownHook

initBasicConsole

initBasicConsole

getExitCode

isTerminated

handle

execute

execute

handleSafe

getArgumentsString

terminateSession

print

printDMR

isColorOutput

printLine

printLine

print

error

input

input

input

interactionDisabled

printColumns

set

get

clear

remove

getModelControllerClient

getCommandLineParser

getCurrentNodePath

getNodePathFormatter

getOperationCandidatesProvider

connectController

connectController

connectController

connectController

bindClient

getCurrentDir

setCurrentDir

registerRedirection

disconnectController

getDefaultControllerHost

getDefaultControllerPort

getDefaultControllerAddress

getControllerHost

getControllerPort

clearScreen

getHistory

isBatchMode

isWorkflowMode

getBatchManager

toBatchedCommand

buildRequest

buildRequest

buildAeshCommandRequest

getDefaultCommandCompleter

getParsedCommandLine

isDomainMode

addEventListener

getConfig

notifyListeners

interact

isResolveParameterValues

setResolveParameterValues

handleClose

isSilent

setSilent

getTerminalWidth

getTerminalHeight

setVariable

getVariable

getVariables

getConnectionInfo