Package 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

Nested Class Summary

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

OperationCommand.HandledRequest

Field Summary

Fields

Modifier and Type	Field	Description
protected String	commandName
protected Set<String>	excludedOps
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

accessRequirement, headers, params, requiredAddress

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

helpArg

Constructor Summary

Constructors

Constructor	Description
GenericTypeOperationHandler(String commandName, CommandContext ctx, String nodeType, String idProperty)	Generic command constructor.
GenericTypeOperationHandler(String commandName, CommandContext ctx, String nodeType, String idProperty, boolean isChildNode)	Generic command constructor.
GenericTypeOperationHandler(String commandName, CommandContext ctx, String nodeType, String idProperty, boolean isChildNode, String... excludeOperations)	Generic command constructor.
GenericTypeOperationHandler(String commandName, CommandContext ctx, String nodeType, String idProperty, String... excludeOperations)	Generic command constructor.
GenericTypeOperationHandler(CommandContext ctx, String nodeType, String idProperty)	Generic command constructor.
GenericTypeOperationHandler(CommandContext ctx, String nodeType, String idProperty, String... excludeOperations)	Generic command constructor.

Method Summary

Modifier and Type	Method	Description
void	addArgument(CommandArgument arg)
void	addHandler(String name, OperationCommandWithDescription handler)
void	addValueCompleter(String propertyName, CommandLineCompleter completer)
void	addValueConverter(String propertyName, ArgumentValueConverter converter)
protected org.jboss.dmr.ModelType	asType(org.jboss.dmr.ModelNode type)
org.jboss.dmr.ModelNode	buildRequestWithoutHeaders(CommandContext ctx)
void	cliEvent(CliEvent event, CommandContext ctx)
protected void	formatProperty(CommandContext ctx, String argName, CharSequence descr)
protected StringBuilder	formatResponse(CommandContext ctx, org.jboss.dmr.ModelNode opResponse, boolean composite, StringBuilder buf)
protected void	formatText(CommandContext ctx, CharSequence text, int offset)
CommandArgument	getArgument(CommandContext ctx, String name)	Returns command argument declared by the command handler corresponding to the argument name.
Collection<CommandArgument>	getArguments(CommandContext ctx)	Returns a collection of the command arguments the handler supports in the current context.
protected Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription>	getAttributeIterator(List<org.jboss.dmr.Property> props, org.jboss.dmr.ModelNode accessControl)
String	getCommandName()
protected Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription>	getNodeProperties(CommandContext ctx)
protected org.jboss.dmr.ModelNode	getOperationDescription(CommandContext ctx, String operationName)
protected List<String>	getSupportedCommands(CommandContext ctx)
protected void	handleResponse(CommandContext ctx, org.jboss.dmr.ModelNode opResponse, boolean composite)
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.
protected org.jboss.dmr.ModelNode	initRequest(CommandContext ctx)
void	printDescription(CommandContext ctx)
protected void	printHelp(CommandContext ctx)
protected void	printNodeDescription(CommandContext ctx)
protected void	printProperties(CommandContext ctx, Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription> props)
protected void	printSupportedCommands(CommandContext ctx)
protected void	recognizeArguments(CommandContext ctx)

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, buildRequestWOValidation, displayResponseHeaders, doHandle, getAttachments, getRequiredAddress, getRequiredType, handleAttachedFile, handleResponse, isAddressValid, isAvailable, isDependsOnProfile, setParams, setupAccessRequirement

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

displayHelp, handle, printList

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

getArgumentsMap

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

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

buildHandledRequest, buildRequest

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

excludedOps

protected final Set<String> excludedOps

helpProperties

protected final ArgumentWithoutValue helpProperties

helpCommands

protected final ArgumentWithoutValue helpCommands

Constructor Detail

GenericTypeOperationHandler

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

Generic command constructor.

Parameters:

ctx - The CommandContext.

nodeType - The resource type. This type is used to name the command.

idProperty - The property name that identify the resource.

GenericTypeOperationHandler

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

Generic command constructor.

Parameters:

commandName - The name of the command. If null, nodeType is used.

ctx - The CommandContext.

nodeType - The resource type.

idProperty - The property name that identify the resource.

GenericTypeOperationHandler

public GenericTypeOperationHandler(String commandName,
                                   CommandContext ctx,
                                   String nodeType,
                                   String idProperty,
                                   boolean isChildNode)

Generic command constructor.

Parameters:

commandName - The name of the command. If null, nodeType is used.

ctx - The CommandContext.

nodeType - The resource type.

idProperty - The property name that identify the resource.

isChildNode - True is the path references a child node, false if the path references a type node.

GenericTypeOperationHandler

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

Generic command constructor.

Parameters:

ctx - The CommandContext.

nodeType - The resource type. This type is used to name the command.

idProperty - The property name that identify the resource.

excludeOperations - The list of operations to exclude.

GenericTypeOperationHandler

public GenericTypeOperationHandler(String commandName,
                                   CommandContext ctx,
                                   String nodeType,
                                   String idProperty,
                                   String... excludeOperations)

Generic command constructor.

Parameters:

commandName - The name of the command. If null, nodeType is used.

ctx - The CommandContext.

nodeType - The resource type.

idProperty - The property name that identify the resource.

excludeOperations - The list of operations to exclude.

GenericTypeOperationHandler

public GenericTypeOperationHandler(String commandName,
                                   CommandContext ctx,
                                   String nodeType,
                                   String idProperty,
                                   boolean isChildNode,
                                   String... excludeOperations)

Generic command constructor.

Parameters:

commandName - The name of the command. If null, nodeType is used.

ctx - The CommandContext.

nodeType - The resource type.

isChildNode - True is the path references a child node, false if the path references a type node.

idProperty - The property name that identify the resource.

excludeOperations - The list of operations to exclude.

Method Detail

getCommandName

public String getCommandName()

addValueConverter

public void addValueConverter(String propertyName,
                              ArgumentValueConverter converter)

addValueCompleter

public void addValueCompleter(String propertyName,
                              CommandLineCompleter completer)

addHandler

public void addHandler(String name,
                       OperationCommandWithDescription handler)

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

Overrides:

getArgument in class CommandHandlerWithArguments

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.

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

asType

protected org.jboss.dmr.ModelType asType(org.jboss.dmr.ModelNode type)

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

Overrides:

hasArgument in class CommandHandlerWithArguments

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

Overrides:

hasArgument in class CommandHandlerWithArguments

Parameters:

ctx - the current context

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

recognizeArguments

protected void recognizeArguments(CommandContext ctx)
                           throws CommandFormatException

Overrides:

recognizeArguments in class CommandHandlerWithArguments

Throws:

CommandFormatException

buildRequestWithoutHeaders

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

Specified by:

buildRequestWithoutHeaders in class BaseOperationCommand

Throws:

CommandFormatException

cliEvent

public void cliEvent(CliEvent event,
                     CommandContext ctx)

Specified by:

cliEvent in interface CliEventListener

Overrides:

cliEvent in class BaseOperationCommand

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

printHelp

protected void printHelp(CommandContext ctx)
                  throws CommandLineException

Overrides:

printHelp in class CommandHandlerWithHelp

Throws:

CommandLineException

printProperties

protected void printProperties(CommandContext ctx,
                               Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription> props)

printDescription

public void printDescription(CommandContext ctx)
                      throws CommandFormatException

Throws:

CommandFormatException

printNodeDescription

protected void printNodeDescription(CommandContext ctx)
                             throws CommandFormatException

Throws:

CommandFormatException

formatText

protected void formatText(CommandContext ctx,
                          CharSequence text,
                          int offset)

formatProperty

protected void formatProperty(CommandContext ctx,
                              String argName,
                              CharSequence descr)

printSupportedCommands

protected void printSupportedCommands(CommandContext ctx)
                               throws CommandLineException

Throws:

CommandLineException

getSupportedCommands

protected List<String> getSupportedCommands(CommandContext ctx)
                                     throws CommandLineException

Throws:

CommandLineException

getNodeProperties

protected Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription> getNodeProperties(CommandContext ctx)
                                                                                                          throws CommandLineException

Throws:

CommandLineException

getAttributeIterator

protected Iterator<org.jboss.as.cli.handlers.GenericTypeOperationHandler.AttributeDescription> getAttributeIterator(List<org.jboss.dmr.Property> props,
                                                                                                                    org.jboss.dmr.ModelNode accessControl)

getOperationDescription

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

Throws:

CommandLineException

initRequest

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

Throws:

CommandFormatException