org.jboss.as.cli.handlers

Class GenericTypeOperationHandler

java.lang.Object

org.jboss.as.cli.handlers.CommandHandlerWithArguments

org.jboss.as.cli.handlers.CommandHandlerWithHelp

org.jboss.as.cli.handlers.BaseOperationCommand

org.jboss.as.cli.handlers.BatchModeCommandHandler

org.jboss.as.cli.handlers.GenericTypeOperationHandler

All Implemented Interfaces:

CliEventListener, CommandHandler, OperationCommand

public class GenericTypeOperationHandler
extends BatchModeCommandHandler

Author:

Alexey Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commandName
protected List<String>	excludeOps
protected ArgumentWithoutValue	helpCommands
protected ArgumentWithoutValue	helpProperties
protected String	idProperty
protected ArgumentWithValue	name
protected String	nodeType
protected ArgumentWithValue	operation
protected ArgumentWithValue	profile

Fields inherited from class org.jboss.as.cli.handlers.BaseOperationCommand

headers, params, requiredAddress

Fields inherited from class org.jboss.as.cli.handlers.CommandHandlerWithHelp

helpArg

Constructor Summary

Constructors

Constructor and Description
GenericTypeOperationHandler(CommandContext ctx, String nodeType, String idProperty)
GenericTypeOperationHandler(CommandContext ctx, String nodeType, String idProperty, List<String> excludeOperations)

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(CommandArgument arg)
void	addValueCompleter(String propertyName, CommandLineCompleter completer)
void	addValueConverter(String propertyName, ArgumentValueConverter converter)
protected org.jboss.dmr.ModelNode	buildOperationRequest(CommandContext ctx, String operation)
org.jboss.dmr.ModelNode	buildRequestWithoutHeaders(CommandContext ctx)
protected org.jboss.dmr.ModelNode	buildWritePropertyRequest(CommandContext ctx)
protected StringBuilder	formatResponse(CommandContext ctx, org.jboss.dmr.ModelNode opResponse, boolean composite, StringBuilder buf)
Collection<CommandArgument>	getArguments(CommandContext ctx) Returns a collection of the command arguments the handler supports in the current context.
protected List<org.jboss.dmr.Property>	getNodeProperties(CommandContext ctx)
protected org.jboss.dmr.ModelNode	getOperationDescription(CommandContext ctx, String operationName)
protected void	handleResponse(CommandContext ctx, org.jboss.dmr.ModelNode opResponse, boolean composite)
boolean	hasArgument(int index) Checks whether the command handler accepts an argument with the specified index.
boolean	hasArgument(String name) Checks whether the command handler recognizes the argument by the name.
protected org.jboss.dmr.ModelNode	initRequest(CommandContext ctx)
protected void	printCommands(CommandContext ctx)
protected void	printHelp(CommandContext ctx)
protected void	printNodeDescription(CommandContext ctx)
protected void	printProperties(CommandContext ctx, List<org.jboss.dmr.Property> props)

Methods inherited from class org.jboss.as.cli.handlers.BatchModeCommandHandler

isBatchMode

Methods inherited from class org.jboss.as.cli.handlers.BaseOperationCommand

addHeaders, addRequiredPath, addRequiredPath, buildRequest, cliEvent, doHandle, getRequiredAddress, getRequiredType, isAvailable, isDependsOnProfile, setParams

Methods inherited from class org.jboss.as.cli.handlers.CommandHandlerWithHelp

handle, printList

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

handle

Field Detail

commandName

protected final String commandName

idProperty

protected final String idProperty

nodeType

protected final String nodeType

profile

protected final ArgumentWithValue profile

name

protected final ArgumentWithValue name

operation

protected final ArgumentWithValue operation

excludeOps

protected final List<String> excludeOps

helpProperties

protected final ArgumentWithoutValue helpProperties

helpCommands

protected final ArgumentWithoutValue helpCommands

Constructor Detail

GenericTypeOperationHandler

public GenericTypeOperationHandler(CommandContext ctx,
                           String nodeType,
                           String idProperty)

GenericTypeOperationHandler

public GenericTypeOperationHandler(CommandContext ctx,
                           String nodeType,
                           String idProperty,
                           List<String> excludeOperations)

Method Detail

addValueConverter

public void addValueConverter(String propertyName,
                     ArgumentValueConverter converter)

addValueCompleter

public void addValueCompleter(String propertyName,
                     CommandLineCompleter completer)

getArguments

public Collection<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

Overrides:

getArguments in class CommandHandlerWithArguments

Parameters:

ctx - current command line context

Returns:

list of the command arguments supported in the current context

hasArgument

public boolean hasArgument(String name)

Description copied from interface: CommandHandler

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

Specified by:

hasArgument in interface CommandHandler

Overrides:

hasArgument in class CommandHandlerWithArguments

Parameters:

name - argument name to check

Returns:

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

hasArgument

public boolean hasArgument(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

Overrides:

hasArgument in class CommandHandlerWithArguments

Parameters:

index - argument index to check

Returns:

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

addArgument

public void addArgument(CommandArgument arg)

Overrides:

addArgument in class BaseOperationCommand

buildRequestWithoutHeaders

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

Specified by:

buildRequestWithoutHeaders in class BaseOperationCommand

Throws:

CommandFormatException

handleResponse

protected void handleResponse(CommandContext ctx,
                  org.jboss.dmr.ModelNode opResponse,
                  boolean composite)
                       throws CommandFormatException

Overrides:

handleResponse in class BaseOperationCommand

Throws:

CommandFormatException

formatResponse

protected StringBuilder formatResponse(CommandContext ctx,
                           org.jboss.dmr.ModelNode opResponse,
                           boolean composite,
                           StringBuilder buf)
                                throws CommandFormatException

Throws:

CommandFormatException

buildWritePropertyRequest

protected org.jboss.dmr.ModelNode buildWritePropertyRequest(CommandContext ctx)
                                                     throws CommandFormatException

Throws:

CommandFormatException

buildOperationRequest

protected org.jboss.dmr.ModelNode buildOperationRequest(CommandContext ctx,
                                            String operation)
                                                 throws CommandFormatException

Throws:

CommandFormatException

printHelp

protected void printHelp(CommandContext ctx)
                  throws CommandFormatException

Overrides:

printHelp in class CommandHandlerWithHelp

Throws:

CommandFormatException

printProperties

protected void printProperties(CommandContext ctx,
                   List<org.jboss.dmr.Property> props)

printNodeDescription

protected void printNodeDescription(CommandContext ctx)
                             throws CommandFormatException

Throws:

CommandFormatException

printCommands

protected void printCommands(CommandContext ctx)
                      throws CommandFormatException

Throws:

CommandFormatException

getNodeProperties

protected List<org.jboss.dmr.Property> getNodeProperties(CommandContext ctx)
                                                  throws CommandFormatException

Throws:

CommandFormatException

getOperationDescription

protected org.jboss.dmr.ModelNode getOperationDescription(CommandContext ctx,
                                              String operationName)
                                                   throws CommandFormatException

Throws:

CommandFormatException

initRequest

protected org.jboss.dmr.ModelNode initRequest(CommandContext ctx)
                                       throws CommandFormatException

Throws:

CommandFormatException