org.jboss.as.controller

Class ListAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.ListAttributeDefinition

Direct Known Subclasses:

ClientMappingsAttributeDefinition, ConnectorRefsAttribute, GlobalModulesDefinition, JASPIAuthenticationModulesAttributeDefinition, JndiEntriesAttribute, LogHandlerListAttributeDefinition, LoginModulesAttributeDefinition, MappingModulesAttributeDefinition, ObjectListAttributeDefinition, ProviderModulesAttributeDefinition, RemotingInterceptorsAttribute, SimpleListAttributeDefinition, SimpleListAttributeDefinition, SocketBindingGroupIncludesAttribute, TimerAttributeDefinition

public abstract class ListAttributeDefinition
extends AttributeDefinition

Defining characteristics of an ModelType.LIST attribute in a Resource, with utility methods for conversion to and from xml and for validation.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
ListAttributeDefinition(String name, boolean allowNull, ParameterValidator elementValidator)
ListAttributeDefinition(String name, boolean allowNull, ParameterValidator elementValidator, AttributeAccess.Flag... flags)
ListAttributeDefinition(String name, String xmlName, boolean allowNull, int minSize, int maxSize, ParameterValidator elementValidator)
ListAttributeDefinition(String name, String xmlName, boolean allowNull, int minSize, int maxSize, ParameterValidator elementValidator, String[] alternatives, String[] requires, AttributeAccess.Flag... flags)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addAttributeValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
org.jboss.dmr.ModelNode	addOperationParameterDescription(org.jboss.dmr.ModelNode resourceDescription, String operationName, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle) Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node.
org.jboss.dmr.ModelNode	addOperationParameterDescription(ResourceBundle bundle, String prefix, org.jboss.dmr.ModelNode operationDescription) Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node.
protected abstract void	addOperationParameterValueTypeDescription(org.jboss.dmr.ModelNode node, String operationName, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
org.jboss.dmr.ModelNode	addResourceAttributeDescription(org.jboss.dmr.ModelNode resourceDescription, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle) Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node.
org.jboss.dmr.ModelNode	addResourceAttributeDescription(ResourceBundle bundle, String prefix, org.jboss.dmr.ModelNode resourceDescription) Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node.
protected abstract void	addValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceBundle bundle)
ParameterValidator	getElementValidator() The validator used to validate elements in the list.
org.jboss.dmr.ModelNode	parse(String value, Location location) Deprecated. use parse(String, XMLStreamReader)
org.jboss.dmr.ModelNode	parse(String value, XMLStreamReader reader) Creates and returns a ModelNode using the given value after first validating the node against this object's element validator.
void	parseAndAddParameterElement(String value, org.jboss.dmr.ModelNode operation, Location location) Deprecated. use parseAndAddParameterElement(String, ModelNode, XMLStreamReader)
void	parseAndAddParameterElement(String value, org.jboss.dmr.ModelNode operation, XMLStreamReader reader) Creates a ModelNode using the given value after first validating the node against this object's validator, and then stores it in the given operation model node as an element in a ModelType.LIST value in a key/value pair whose key is this attribute's name.

Methods inherited from class org.jboss.as.controller.AttributeDefinition

correctValue, getAlternatives, getAttributeTextDescription, getDefaultValue, getFlags, getMeasurementUnit, getName, getNoTextDescription, getRequires, getType, getValidator, getXmlName, hasAlternative, isAllowed, isAllowExpression, isAllowNull, isMarshallable, isMarshallable, isRequired, marshallAsElement, resolveModelAttribute, validateAndSet, validateOperation, validateResolvedOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

ListAttributeDefinition

public ListAttributeDefinition(String name,
                       boolean allowNull,
                       ParameterValidator elementValidator)

ListAttributeDefinition

public ListAttributeDefinition(String name,
                       boolean allowNull,
                       ParameterValidator elementValidator,
                       AttributeAccess.Flag... flags)

ListAttributeDefinition

public ListAttributeDefinition(String name,
                       String xmlName,
                       boolean allowNull,
                       int minSize,
                       int maxSize,
                       ParameterValidator elementValidator)

ListAttributeDefinition

public ListAttributeDefinition(String name,
                       String xmlName,
                       boolean allowNull,
                       int minSize,
                       int maxSize,
                       ParameterValidator elementValidator,
                       String[] alternatives,
                       String[] requires,
                       AttributeAccess.Flag... flags)

Method Detail

getElementValidator

public ParameterValidator getElementValidator()

The validator used to validate elements in the list.

Returns:

the element validator

parse

public org.jboss.dmr.ModelNode parse(String value,
                            XMLStreamReader reader)
                              throws XMLStreamException

Creates and returns a ModelNode using the given value after first validating the node against this object's element validator.

If value is null an undefined node will be returned.

Parameters:

value - the value. Will be trimmed before use if not null.

reader - XMLStreamReader from which the location from which the attribute value was read can be obtained and used in any XMLStreamException, in case the given value is invalid.

Returns:

ModelNode representing the parsed value

Throws:

XMLStreamException - if value is not valid

See Also:

parseAndAddParameterElement(String, ModelNode, XMLStreamReader)

parse

@Deprecated
public org.jboss.dmr.ModelNode parse(String value,
                                       Location location)
                              throws XMLStreamException

Deprecated. use parse(String, XMLStreamReader)

Creates and returns a ModelNode using the given value after first validating the node against this object's element validator.

If value is null an undefined node will be returned.

Parameters:

value - the value. Will be trimmed before use if not null.

location - current location of the parser's XMLStreamReader. Used for any exception message

Returns:

ModelNode representing the parsed value

Throws:

XMLStreamException - if value is not valid

See Also:

parseAndAddParameterElement(String, ModelNode, Location)

parseAndAddParameterElement

public void parseAndAddParameterElement(String value,
                               org.jboss.dmr.ModelNode operation,
                               XMLStreamReader reader)
                                 throws XMLStreamException

Creates a ModelNode using the given value after first validating the node against this object's validator, and then stores it in the given operation model node as an element in a ModelType.LIST value in a key/value pair whose key is this attribute's name.

If value is null an undefined node will be stored if such a value is acceptable to the validator.

The expected usage of this method is in parsers seeking to build up an operation to store their parsed data into the configuration.

Parameters:

value - the value. Will be trimmed before use if not null.

operation - model node of type ModelType.OBJECT into which the parsed value should be stored

reader - XMLStreamReader from which the location from which the attribute value was read can be obtained and used in any XMLStreamException, in case the given value is invalid.

Throws:

XMLStreamException - if value is not valid

parseAndAddParameterElement

@Deprecated
public void parseAndAddParameterElement(String value,
                                          org.jboss.dmr.ModelNode operation,
                                          Location location)
                                 throws XMLStreamException

Deprecated. use parseAndAddParameterElement(String, ModelNode, XMLStreamReader)

Creates a ModelNode using the given value after first validating the node against this object's validator, and then stores it in the given operation model node as an element in a ModelType.LIST value in a key/value pair whose key is this attribute's name.

If value is null an undefined node will be stored if such a value is acceptable to the validator.

The expected usage of this method is in parsers seeking to build up an operation to store their parsed data into the configuration.

Parameters:

value - the value. Will be trimmed before use if not null.

operation - model node of type ModelType.OBJECT into which the parsed value should be stored

location - current location of the parser's XMLStreamReader. Used for any exception message

Throws:

XMLStreamException - if value is not valid

addResourceAttributeDescription

public org.jboss.dmr.ModelNode addResourceAttributeDescription(ResourceBundle bundle,
                                                      String prefix,
                                                      org.jboss.dmr.ModelNode resourceDescription)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node. The node describing the attribute is returned to make it easy to perform further modification.

Overrides:

addResourceAttributeDescription in class AttributeDefinition

Parameters:

bundle - resource bundle to use for text descriptions

prefix - prefix to prepend to the attribute name key when looking up descriptions

resourceDescription - the overall resource description

Returns:

the attribute description node

addResourceAttributeDescription

public org.jboss.dmr.ModelNode addResourceAttributeDescription(org.jboss.dmr.ModelNode resourceDescription,
                                                      ResourceDescriptionResolver resolver,
                                                      Locale locale,
                                                      ResourceBundle bundle)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node. The node describing the attribute is returned to make it easy to perform further modification.

Overrides:

addResourceAttributeDescription in class AttributeDefinition

Parameters:

resourceDescription - the overall resource description

resolver - provider of localized text descriptions

locale - locale to pass to the resolver

bundle - bundle to pass to the resolver

Returns:

the attribute description node

addOperationParameterDescription

public org.jboss.dmr.ModelNode addOperationParameterDescription(org.jboss.dmr.ModelNode resourceDescription,
                                                       String operationName,
                                                       ResourceDescriptionResolver resolver,
                                                       Locale locale,
                                                       ResourceBundle bundle)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node. The node describing the parameter is returned to make it easy to perform further modification.

Overrides:

addOperationParameterDescription in class AttributeDefinition

Parameters:

resourceDescription - the overall resource description

operationName - the operation name

resolver - provider of localized text descriptions

locale - locale to pass to the resolver

bundle - bundle to pass to the resolver

Returns:

the attribute description node

addOperationParameterDescription

public org.jboss.dmr.ModelNode addOperationParameterDescription(ResourceBundle bundle,
                                                       String prefix,
                                                       org.jboss.dmr.ModelNode operationDescription)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node. The node describing the parameter is returned to make it easy to perform further modification.

Overrides:

addOperationParameterDescription in class AttributeDefinition

Parameters:

bundle - resource bundle to use for text descriptions

prefix - prefix to prepend to the attribute name key when looking up descriptions

operationDescription - the overall resource description

Returns:

the attribute description node

addValueTypeDescription

protected abstract void addValueTypeDescription(org.jboss.dmr.ModelNode node,
                           ResourceBundle bundle)

addAttributeValueTypeDescription

protected abstract void addAttributeValueTypeDescription(org.jboss.dmr.ModelNode node,
                                    ResourceDescriptionResolver resolver,
                                    Locale locale,
                                    ResourceBundle bundle)

addOperationParameterValueTypeDescription

protected abstract void addOperationParameterValueTypeDescription(org.jboss.dmr.ModelNode node,
                                             String operationName,
                                             ResourceDescriptionResolver resolver,
                                             Locale locale,
                                             ResourceBundle bundle)