Package org.jboss.as.clustering.controller

Class ResourceDescriptor

java.lang.Object

org.jboss.as.clustering.controller.ResourceDescriptor

All Implemented Interfaces:

AddStepHandlerDescriptor, OperationStepHandlerDescriptor, RemoveStepHandlerDescriptor, WriteAttributeStepHandlerDescriptor

public class ResourceDescriptor
extends Object
implements AddStepHandlerDescriptor

Describes the properties of resource used by AddStepHandler. Supports supplying attributes and capabilities via enumerations. Also supports defining extra parameters that are not actually attributes of the target resource.

Author:

Paul Ferraro

Constructor Summary

Constructors

Constructor	Description
ResourceDescriptor(org.jboss.as.controller.descriptions.ResourceDescriptionResolver resolver)

Method Summary

Modifier and Type	Method	Description
ResourceDescriptor	addAlias(Attribute alias, Attribute target)
ResourceDescriptor	addAttribute(Attribute attribute, org.jboss.as.controller.OperationStepHandler writeAttributeHandler)
ResourceDescriptor	addAttribute(org.jboss.as.controller.AttributeDefinition attribute, org.jboss.as.controller.OperationStepHandler writeAttributeHandler)
<E extends Enum<E> & Attribute> ResourceDescriptor	addAttributes(Class<E> enumClass)
ResourceDescriptor	addAttributes(Iterable<org.jboss.as.controller.AttributeDefinition> attributes)
ResourceDescriptor	addAttributes(Set<? extends Attribute> attributes)
ResourceDescriptor	addAttributes(Attribute... attributes)
ResourceDescriptor	addAttributes(org.jboss.as.controller.AttributeDefinition... attributes)
ResourceDescriptor	addAttributeTranslation(Attribute sourceAttribute, AttributeTranslation translation)
<E extends Enum<E> & Capability> ResourceDescriptor	addCapabilities(Class<E> enumClass)
ResourceDescriptor	addCapabilities(Iterable<? extends Capability> capabilities)
<E extends Enum<E> & Capability> ResourceDescriptor	addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate, Class<E> enumClass)
ResourceDescriptor	addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate, Iterable<? extends Capability> capabilities)
ResourceDescriptor	addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate, Capability... capabilities)
ResourceDescriptor	addCapabilities(Capability... capabilities)
<E extends Enum<E> & Attribute> ResourceDescriptor	addExtraParameters(Class<E> enumClass)
ResourceDescriptor	addExtraParameters(Iterable<org.jboss.as.controller.AttributeDefinition> parameters)
ResourceDescriptor	addExtraParameters(Set<? extends Attribute> parameters)
ResourceDescriptor	addExtraParameters(Attribute... parameters)
ResourceDescriptor	addExtraParameters(org.jboss.as.controller.AttributeDefinition... parameters)
<E extends Enum<E> & Attribute> ResourceDescriptor	addIgnoredAttributes(Class<E> enumClass)
ResourceDescriptor	addIgnoredAttributes(Iterable<org.jboss.as.controller.AttributeDefinition> attributes)
ResourceDescriptor	addIgnoredAttributes(Set<? extends Attribute> attributes)
ResourceDescriptor	addIgnoredAttributes(Attribute... attributes)
ResourceDescriptor	addIgnoredAttributes(org.jboss.as.controller.AttributeDefinition... attributes)
<E extends Enum<E> & ResourceDefinitionProvider> ResourceDescriptor	addRequiredChildren(Class<E> enumClass)
ResourceDescriptor	addRequiredChildren(Iterable<org.jboss.as.controller.PathElement> paths)
ResourceDescriptor	addRequiredChildren(Set<? extends ResourceDefinitionProvider> providers)
ResourceDescriptor	addRequiredChildren(org.jboss.as.controller.PathElement... paths)
<E extends Enum<E> & org.jboss.as.controller.ResourceDefinition> ResourceDescriptor	addRequiredSingletonChildren(Class<E> enumClass)
ResourceDescriptor	addRequiredSingletonChildren(Iterable<org.jboss.as.controller.PathElement> paths)
ResourceDescriptor	addRequiredSingletonChildren(Set<? extends org.jboss.as.controller.ResourceDefinition> definitions)
ResourceDescriptor	addRequiredSingletonChildren(org.jboss.as.controller.PathElement... paths)
ResourceDescriptor	addResourceCapabilityReference(org.jboss.as.controller.CapabilityReferenceRecorder reference)
ResourceDescriptor	addRuntimeResourceRegistration(RuntimeResourceRegistration registration)
UnaryOperator<org.jboss.as.controller.OperationStepHandler>	getAddOperationTransformation()	Returns a transformer for the add operation handler.
Collection<org.jboss.as.controller.AttributeDefinition>	getAttributes()	Attributes of the add operation.
Map<org.jboss.as.controller.AttributeDefinition,AttributeTranslation>	getAttributeTranslations()	Returns a mapping of attribute translations
Map<Capability,Predicate<org.jboss.dmr.ModelNode>>	getCapabilities()	The capabilities provided by this resource, paired with the condition under which they should be [un]registered
Map<org.jboss.as.controller.AttributeDefinition,org.jboss.as.controller.OperationStepHandler>	getCustomAttributes()	Custom attributes of the add operation, processed using a specific write-attribute handler.
org.jboss.as.controller.descriptions.ResourceDescriptionResolver	getDescriptionResolver()	The description resolver for the operation.
Collection<org.jboss.as.controller.AttributeDefinition>	getExtraParameters()	Extra parameters (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) for the add operation.
Collection<org.jboss.as.controller.AttributeDefinition>	getIgnoredAttributes()	Attributes (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) will be ignored at runtime..
UnaryOperator<org.jboss.as.controller.OperationStepHandler>	getOperationTransformation()	Returns a transformer to be applied to all operations that operate on an existing resource.
Set<org.jboss.as.controller.PathElement>	getRequiredChildren()	Returns the required child resources for this resource description.
Set<org.jboss.as.controller.PathElement>	getRequiredSingletonChildren()	Returns the required singleton child resources for this resource description.
Set<org.jboss.as.controller.CapabilityReferenceRecorder>	getResourceCapabilityReferences()	Returns a mapping of capability references to an ancestor resource.
UnaryOperator<org.jboss.as.controller.registry.Resource>	getResourceTransformation()	Returns a transformation for a newly created resource.
Collection<RuntimeResourceRegistration>	getRuntimeResourceRegistrations()	Returns a collection of handlers that register runtime resources Runtime resource registrations are executed in a separate MODEL stage step.
ResourceDescriptor	setAddOperationTransformation(UnaryOperator<org.jboss.as.controller.OperationStepHandler> transformation)
ResourceDescriptor	setOperationTransformation(UnaryOperator<org.jboss.as.controller.OperationStepHandler> transformation)
ResourceDescriptor	setResourceTransformation(UnaryOperator<org.jboss.as.controller.registry.Resource> transformation)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceDescriptor

public ResourceDescriptor(org.jboss.as.controller.descriptions.ResourceDescriptionResolver resolver)

Method Detail

getDescriptionResolver

public org.jboss.as.controller.descriptions.ResourceDescriptionResolver getDescriptionResolver()

Description copied from interface: RemoveStepHandlerDescriptor

The description resolver for the operation.

Specified by:

getDescriptionResolver in interface RemoveStepHandlerDescriptor

Returns:

a description resolver

getCapabilities

public Map<Capability,Predicate<org.jboss.dmr.ModelNode>> getCapabilities()

Description copied from interface: OperationStepHandlerDescriptor

The capabilities provided by this resource, paired with the condition under which they should be [un]registered

Specified by:

getCapabilities in interface OperationStepHandlerDescriptor

Returns:

a map of capabilities to predicates

getAttributes

public Collection<org.jboss.as.controller.AttributeDefinition> getAttributes()

Description copied from interface: WriteAttributeStepHandlerDescriptor

Attributes of the add operation.

Specified by:

getAttributes in interface WriteAttributeStepHandlerDescriptor

Returns:

a collection of attributes

getIgnoredAttributes

public Collection<org.jboss.as.controller.AttributeDefinition> getIgnoredAttributes()

Description copied from interface: WriteAttributeStepHandlerDescriptor

Attributes (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) will be ignored at runtime..

Specified by:

getIgnoredAttributes in interface WriteAttributeStepHandlerDescriptor

Returns:

a collection of ignored attributes

getExtraParameters

public Collection<org.jboss.as.controller.AttributeDefinition> getExtraParameters()

Description copied from interface: AddStepHandlerDescriptor

Extra parameters (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) for the add operation.

Specified by:

getExtraParameters in interface AddStepHandlerDescriptor

Returns:

a collection of attributes

getRequiredChildren

public Set<org.jboss.as.controller.PathElement> getRequiredChildren()

Description copied from interface: AddStepHandlerDescriptor

Returns the required child resources for this resource description.

Specified by:

getRequiredChildren in interface AddStepHandlerDescriptor

Returns:

a collection of resource paths

getRequiredSingletonChildren

public Set<org.jboss.as.controller.PathElement> getRequiredSingletonChildren()

Description copied from interface: AddStepHandlerDescriptor

Returns the required singleton child resources for this resource description. This means only one child resource should exist for the given child type.

Specified by:

getRequiredSingletonChildren in interface AddStepHandlerDescriptor

Returns:

a collection of resource paths

getAttributeTranslations

public Map<org.jboss.as.controller.AttributeDefinition,AttributeTranslation> getAttributeTranslations()

Description copied from interface: AddStepHandlerDescriptor

Returns a mapping of attribute translations

Specified by:

getAttributeTranslations in interface AddStepHandlerDescriptor

Returns:

an attribute translation mapping

getCustomAttributes

public Map<org.jboss.as.controller.AttributeDefinition,org.jboss.as.controller.OperationStepHandler> getCustomAttributes()

Description copied from interface: AddStepHandlerDescriptor

Custom attributes of the add operation, processed using a specific write-attribute handler.

Specified by:

getCustomAttributes in interface AddStepHandlerDescriptor

Returns:

a map of attributes and their write-attribute handler

getRuntimeResourceRegistrations

public Collection<RuntimeResourceRegistration> getRuntimeResourceRegistrations()

Description copied from interface: RemoveStepHandlerDescriptor

Returns a collection of handlers that register runtime resources Runtime resource registrations are executed in a separate MODEL stage step.

Specified by:

getRuntimeResourceRegistrations in interface RemoveStepHandlerDescriptor

Returns:

a collection of operation step handlers

getResourceCapabilityReferences

public Set<org.jboss.as.controller.CapabilityReferenceRecorder> getResourceCapabilityReferences()

Description copied from interface: RemoveStepHandlerDescriptor

Returns a mapping of capability references to an ancestor resource.

Specified by:

getResourceCapabilityReferences in interface RemoveStepHandlerDescriptor

Returns:

a tuple of capability references and requirement resolvers.

getOperationTransformation

public UnaryOperator<org.jboss.as.controller.OperationStepHandler> getOperationTransformation()

Description copied from interface: RemoveStepHandlerDescriptor

Returns a transformer to be applied to all operations that operate on an existing resource. This is typically used to adapt legacy operations to conform to the current version of the model.

Specified by:

getOperationTransformation in interface RemoveStepHandlerDescriptor

Returns:

an operation handler transformer.

getResourceTransformation

public UnaryOperator<org.jboss.as.controller.registry.Resource> getResourceTransformation()

Description copied from interface: AddStepHandlerDescriptor

Returns a transformation for a newly created resource.

Specified by:

getResourceTransformation in interface AddStepHandlerDescriptor

Returns:

a resource transformation

getAddOperationTransformation

public UnaryOperator<org.jboss.as.controller.OperationStepHandler> getAddOperationTransformation()

Description copied from interface: AddStepHandlerDescriptor

Returns a transformer for the add operation handler. This is typically used to adapt legacy operations to conform to the current version of the model.

Specified by:

getAddOperationTransformation in interface AddStepHandlerDescriptor

Returns:

an operation handler transformer.

addAttribute

public ResourceDescriptor addAttribute(Attribute attribute,
                                       org.jboss.as.controller.OperationStepHandler writeAttributeHandler)

addAttribute

public ResourceDescriptor addAttribute(org.jboss.as.controller.AttributeDefinition attribute,
                                       org.jboss.as.controller.OperationStepHandler writeAttributeHandler)

addAttributes

public <E extends Enum<E> & Attribute> ResourceDescriptor addAttributes(Class<E> enumClass)

addAttributes

public ResourceDescriptor addAttributes(Set<? extends Attribute> attributes)

addAttributes

public ResourceDescriptor addAttributes(Attribute... attributes)

addAttributes

public ResourceDescriptor addAttributes(org.jboss.as.controller.AttributeDefinition... attributes)

addAttributes

public ResourceDescriptor addAttributes(Iterable<org.jboss.as.controller.AttributeDefinition> attributes)

addIgnoredAttributes

public <E extends Enum<E> & Attribute> ResourceDescriptor addIgnoredAttributes(Class<E> enumClass)

addIgnoredAttributes

public ResourceDescriptor addIgnoredAttributes(Set<? extends Attribute> attributes)

addIgnoredAttributes

public ResourceDescriptor addIgnoredAttributes(Attribute... attributes)

addIgnoredAttributes

public ResourceDescriptor addIgnoredAttributes(org.jboss.as.controller.AttributeDefinition... attributes)

addIgnoredAttributes

public ResourceDescriptor addIgnoredAttributes(Iterable<org.jboss.as.controller.AttributeDefinition> attributes)

addExtraParameters

public <E extends Enum<E> & Attribute> ResourceDescriptor addExtraParameters(Class<E> enumClass)

addExtraParameters

public ResourceDescriptor addExtraParameters(Set<? extends Attribute> parameters)

addExtraParameters

public ResourceDescriptor addExtraParameters(Attribute... parameters)

addExtraParameters

public ResourceDescriptor addExtraParameters(org.jboss.as.controller.AttributeDefinition... parameters)

addExtraParameters

public ResourceDescriptor addExtraParameters(Iterable<org.jboss.as.controller.AttributeDefinition> parameters)

addCapabilities

public <E extends Enum<E> & Capability> ResourceDescriptor addCapabilities(Class<E> enumClass)

addCapabilities

public ResourceDescriptor addCapabilities(Capability... capabilities)

addCapabilities

public ResourceDescriptor addCapabilities(Iterable<? extends Capability> capabilities)

addCapabilities

public <E extends Enum<E> & Capability> ResourceDescriptor addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate,
                                                                           Class<E> enumClass)

addCapabilities

public ResourceDescriptor addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate,
                                          Capability... capabilities)

addCapabilities

public ResourceDescriptor addCapabilities(Predicate<org.jboss.dmr.ModelNode> predicate,
                                          Iterable<? extends Capability> capabilities)

addRequiredChildren

public <E extends Enum<E> & ResourceDefinitionProvider> ResourceDescriptor addRequiredChildren(Class<E> enumClass)

addRequiredChildren

public ResourceDescriptor addRequiredChildren(Set<? extends ResourceDefinitionProvider> providers)

addRequiredChildren

public ResourceDescriptor addRequiredChildren(org.jboss.as.controller.PathElement... paths)

addRequiredChildren

public ResourceDescriptor addRequiredChildren(Iterable<org.jboss.as.controller.PathElement> paths)

addRequiredSingletonChildren

public <E extends Enum<E> & org.jboss.as.controller.ResourceDefinition> ResourceDescriptor addRequiredSingletonChildren(Class<E> enumClass)

addRequiredSingletonChildren

public ResourceDescriptor addRequiredSingletonChildren(Set<? extends org.jboss.as.controller.ResourceDefinition> definitions)

addRequiredSingletonChildren

public ResourceDescriptor addRequiredSingletonChildren(org.jboss.as.controller.PathElement... paths)

addRequiredSingletonChildren

public ResourceDescriptor addRequiredSingletonChildren(Iterable<org.jboss.as.controller.PathElement> paths)

addAlias

public ResourceDescriptor addAlias(Attribute alias,
                                   Attribute target)

addAttributeTranslation

public ResourceDescriptor addAttributeTranslation(Attribute sourceAttribute,
                                                  AttributeTranslation translation)

addRuntimeResourceRegistration

public ResourceDescriptor addRuntimeResourceRegistration(RuntimeResourceRegistration registration)

addResourceCapabilityReference

public ResourceDescriptor addResourceCapabilityReference(org.jboss.as.controller.CapabilityReferenceRecorder reference)

setAddOperationTransformation

public ResourceDescriptor setAddOperationTransformation(UnaryOperator<org.jboss.as.controller.OperationStepHandler> transformation)

setOperationTransformation

public ResourceDescriptor setOperationTransformation(UnaryOperator<org.jboss.as.controller.OperationStepHandler> transformation)

setResourceTransformation

public ResourceDescriptor setResourceTransformation(UnaryOperator<org.jboss.as.controller.registry.Resource> transformation)