Package org.jboss.as.cli.handlers

Class OperationRequestHandler

java.lang.Object

org.jboss.as.cli.handlers.OperationRequestHandler

All Implemented Interfaces:

CommandHandler, OperationCommand

public class OperationRequestHandler
extends Object
implements CommandHandler, OperationCommand

The operation request handler.

Author:

Alexey Loubyansky

Nested Class Summary

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

OperationCommand.HandledRequest

Constructor Summary

Constructors

Constructor	Description
OperationRequestHandler()

Method Summary

Modifier and Type	Method	Description
org.jboss.dmr.ModelNode	buildRequest(CommandContext ctx)
CommandArgument	getArgument(CommandContext ctx, String name)	Returns command argument declared by the command handler corresponding to the argument name.
List<CommandArgument>	getArguments(CommandContext ctx)	Returns a collection of the command arguments the handler supports in the current context.
void	handle(CommandContext ctx)	Executes the command.
boolean	hasArgument(CommandContext ctx, int index)	Checks whether the command handler accepts an argument with the specified index.
boolean	hasArgument(CommandContext ctx, String name)	Checks whether the command handler recognizes the argument by the name.
boolean	isAvailable(CommandContext ctx)	Checks whether the command is available in the current context (e.g. some commands require connection with the controller, some are available only in the batch mode, etc)
boolean	isBatchMode(CommandContext ctx)	Whether the command supports batch mode or not.

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.OperationCommand

buildHandledRequest, buildRequest

Constructor Detail

OperationRequestHandler

public OperationRequestHandler()

Method Detail

isBatchMode

public boolean isBatchMode(CommandContext ctx)

Description copied from interface: CommandHandler

Whether the command supports batch mode or not. The result could depend on the context, e.g. it won't make sense to add 'some_command --help' to a batch.

Specified by:

isBatchMode in interface CommandHandler

Parameters:

ctx - the current context

Returns:

true if the command can be added to the batch, otherwise - false.

handle

public void handle(CommandContext ctx)
            throws CommandLineException

Description copied from interface: CommandHandler

Executes the command.

Specified by:

handle in interface CommandHandler

Parameters:

ctx - current command context

Throws:

CommandLineException - if for any reason the command can't be properly handled the implementation must throw an instance of CommandLineException.

isAvailable

public boolean isAvailable(CommandContext ctx)

Description copied from interface: CommandHandler

Checks whether the command is available in the current context (e.g. some commands require connection with the controller, some are available only in the batch mode, etc)

Specified by:

isAvailable in interface CommandHandler

Parameters:

ctx - current context

Returns:

true if the command can be executed in the current context, false - otherwise.

buildRequest

public org.jboss.dmr.ModelNode buildRequest(CommandContext ctx)
                                     throws CommandFormatException

Specified by:

buildRequest in interface OperationCommand

Throws:

CommandFormatException

getArgument

public CommandArgument getArgument(CommandContext ctx,
                                   String name)

Description copied from interface: CommandHandler

Returns command argument declared by the command handler corresponding to the argument name. Or null if the argument wasn't found among the accepted arguments.

Specified by:

getArgument in interface CommandHandler

Parameters:

ctx - the current context

name - the name of the argument

Returns:

command argument corresponding to the argument name or null if the argument name wasn't recognized.

hasArgument

public boolean hasArgument(CommandContext ctx,
                           String name)

Description copied from interface: CommandHandler

Checks whether the command handler recognizes the argument by the name.

Specified by:

hasArgument in interface CommandHandler

Parameters:

ctx - the current context

name - argument name to check

Returns:

true if the handler recognizes the argument, otherwise - false.

hasArgument

public boolean hasArgument(CommandContext ctx,
                           int index)

Description copied from interface: CommandHandler

Checks whether the command handler accepts an argument with the specified index.

Specified by:

hasArgument in interface CommandHandler

Parameters:

ctx - the current context

index - argument index to check

Returns:

true if the handler accepts an argument with the specified index, otherwise - false.

getArguments

public List<CommandArgument> getArguments(CommandContext ctx)

Description copied from interface: CommandHandler

Returns a collection of the command arguments the handler supports in the current context.

Specified by:

getArguments in interface CommandHandler

Parameters:

ctx - current command line context

Returns:

list of the command arguments supported in the current context