org.jboss.as.controller

Class ListAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.ListAttributeDefinition

Direct Known Subclasses:

ObjectListAttributeDefinition, PrimitiveListAttributeDefinition, SimpleListAttributeDefinition

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAttributeDefinition.Builder<BUILDER extends ListAttributeDefinition.Builder,ATTRIBUTE extends ListAttributeDefinition>

Nested classes/interfaces inherited from class org.jboss.as.controller.AttributeDefinition

AttributeDefinition.NameAndGroup

Field Summary

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

attributeMarshaller, COMPLEX_TYPES, referenceRecorder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListAttributeDefinition(ListAttributeDefinition.Builder<?,?> builder)
	ListAttributeDefinition(String name, boolean allowNull, ParameterValidator elementValidator) Deprecated.
	ListAttributeDefinition(String name, boolean allowNull, ParameterValidator elementValidator, AttributeAccess.Flag... flags) Deprecated.

Method Summary

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	addOperationReplyDescription(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.
protected void	addOperationReplyValueTypeDescription(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)
protected org.jboss.dmr.ModelNode	convertParameterElementExpressions(org.jboss.dmr.ModelNode parameterElement) Examine the given element of a parameter list for any expression syntax, converting the relevant node to ModelType.EXPRESSION if such is supported.
protected org.jboss.dmr.ModelNode	convertParameterExpressions(org.jboss.dmr.ModelNode parameter) Iterates through the elements in the parameter list, calling convertParameterElementExpressions(ModelNode) for each.
ParameterValidator	getElementValidator() The validator used to validate elements in the list.
void	marshallAsElement(org.jboss.dmr.ModelNode resourceModel, boolean marshallDefault, XMLStreamWriter writer) Marshalls the value from the given resourceModel as an xml element, if it is marshallable.
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, XMLStreamReader reader) Creates a ModelNode using the given value after first validating the node against this object's element 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.
void	parseAndSetParameter(String value, org.jboss.dmr.ModelNode operation, XMLStreamReader reader) Deprecated. in favour of using attribute parser

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

addAccessConstraints, addAllowedValuesToDescription, addCapabilityRequirements, addDeprecatedInfo, addOperationReplyDescription, convertStringExpression, correctValue, getAccessConstraints, getAllowedValues, getAlternatives, getArbitraryDescriptors, getAttributeDeprecatedDescription, getAttributeGroup, getAttributeMarshaller, getAttributeTextDescription, getCorrector, getDefaultValue, getDeprecationData, getFlags, getMeasurementUnit, getName, getNoTextDescription, getParser, getReferenceRecorder, getRequires, getType, getUndefinedMetricValue, getValidator, getXmlName, hasAlternative, hasCapabilityRequirements, isAllowed, isAllowExpression, isAllowNull, isDeprecated, isMarshallable, isMarshallable, isNillable, isNullSignificant, isRequired, isRequired, isResourceOnly, isValidatingNull, marshallAsElement, removeCapabilityRequirements, resolveModelAttribute, resolveModelAttribute, resolveValue, resolveValue, validateAndSet, validateOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

ListAttributeDefinition

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

Deprecated.

ListAttributeDefinition

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

Deprecated.

ListAttributeDefinition

protected ListAttributeDefinition(ListAttributeDefinition.Builder<?,?> builder)

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)

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 element 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

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

addOperationReplyDescription

public org.jboss.dmr.ModelNode addOperationReplyDescription(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:

addOperationReplyDescription 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

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)

addOperationReplyValueTypeDescription

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

marshallAsElement

public void marshallAsElement(org.jboss.dmr.ModelNode resourceModel,
                              boolean marshallDefault,
                              XMLStreamWriter writer)
                       throws XMLStreamException

Description copied from class: AttributeDefinition

Marshalls the value from the given resourceModel as an xml element, if it is marshallable.

Overrides:

marshallAsElement in class AttributeDefinition

Parameters:

resourceModel - the model, a non-null node of ModelType.OBJECT.

marshallDefault - true if the value should be marshalled even if it matches the default value

writer - stream writer to use for writing the attribute

Throws:

XMLStreamException - if thrown by writer

convertParameterExpressions

protected org.jboss.dmr.ModelNode convertParameterExpressions(org.jboss.dmr.ModelNode parameter)

Iterates through the elements in the parameter list, calling convertParameterElementExpressions(ModelNode) for each.

Note that the default implementation of convertParameterElementExpressions(ModelNode) will only convert simple ModelType.STRING elements. If users need to handle complex elements with embedded expressions, they should use a subclass that overrides that method.

Examine the given operation parameter value for any expression syntax, converting the relevant node to ModelType.EXPRESSION if such is supported.

This implementation checks if expressions are allowed and if so, calls AttributeDefinition.convertStringExpression(ModelNode) to convert a ModelType.STRING to a ModelType.EXPRESSION. No other conversions are performed. For use cases requiring more complex behavior, a subclass that overrides this method should be used.

If expressions are supported this implementation also checks if the attribute type is one of the complex DMR types. If it is, an IllegalStateException is thrown, as this implementation cannot properly handle such a combination, and a subclass that overrides this method should be used.

Overrides:

convertParameterExpressions in class AttributeDefinition

Parameters:

parameter - the node to examine. Cannot not be null

Returns:

a node matching parameter but with expressions converted, or the original parameter if no conversion was performed. Will not return null

convertParameterElementExpressions

protected org.jboss.dmr.ModelNode convertParameterElementExpressions(org.jboss.dmr.ModelNode parameterElement)

Examine the given element of a parameter list for any expression syntax, converting the relevant node to ModelType.EXPRESSION if such is supported. This implementation will only convert elements of ModelType.STRING. Subclasses that need to handle complex elements should override this method.

Parameters:

parameterElement - the node to examine. Will not be null

Returns:

the parameter element with expressions converted, or the original parameter if no conversion was performed Cannot return null

parseAndSetParameter

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

Deprecated. in favour of using attribute parser

parses whole value as list attribute and uses "," separator splitting list elements

Parameters:

value - String with "," separated string elements

operation - operation to with this list elements are added

reader - xml reader from where reading is be done

Throws:

XMLStreamException