Package org.wildfly.subsystem.resource

Class ResourceDescriptor.DefaultResourceDescriptor

java.lang.Object

org.wildfly.subsystem.resource.ResourceDescriptor.DefaultResourceDescriptor

All Implemented Interfaces:

AddResourceOperationStepHandlerDescriptor, OperationStepHandlerDescriptor, ResourceDescriptor

Enclosing interface:

ResourceDescriptor

public static class ResourceDescriptor.DefaultResourceDescriptor
extends Object
implements ResourceDescriptor

Default ResourceDescriptor implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wildfly.subsystem.resource.ResourceDescriptor

ResourceDescriptor.AbstractConfigurator<C extends ResourceDescriptor.Configurator<C>>, ResourceDescriptor.Builder, ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>, ResourceDescriptor.DefaultBuilder, ResourceDescriptor.DefaultResourceDescriptor

Method Summary

Modifier and Type	Method	Description
OperationEntry.Flag	getAddOperationRestartFlag()	Returns the restart flag for the "add"} operation of this resource.
UnaryOperator<OperationStepHandler>	getAddOperationTransformation()	Returns a transformer for the add operation handler.
Iterable<AttributeDefinition>	getAttributes()	Attributes of the the resource affecting runtime.
AttributeTranslation	getAttributeTranslation(AttributeDefinition attribute)	Returns the attribute translation for the specified attribute, or null if none exists
Set<RuntimeCapability<?>>	getCapabilities()	The capabilities provided by this resource
BiPredicate<OperationContext,Resource>	getCapabilityFilter(RuntimeCapability<?> capability)	Returns the resource model filter used to determine whether the specified capability should be [un]registered.
Optional<Consumer<DeploymentProcessorTarget>>	getDeploymentChainContributor()	Returns an optional consumer of a DeploymentProcessorTarget, used to add deployment unit processors to the deployment chain.
OperationEntry.Flag	getRemoveOperationRestartFlag()	Returns the restart flag for the "remove" operation of this resource.
Set<PathElement>	getRequiredChildren()	Returns the required child resources for this resource description.
Set<PathElement>	getRequiredSingletonChildren()	Returns the required singleton child resources for this resource description.
Set<ResourceCapabilityReferenceRecorder<?>>	getResourceCapabilityReferences()	Returns a mapping of capability references to an ancestor resource.
ResourceDescriptionResolver	getResourceDescriptionResolver()	The description resolver for the operation.
UnaryOperator<OperationStepHandler>	getResourceOperationTransformation()	Returns a transformer to be applied to all operations that operate on an existing resource.
UnaryOperator<Resource>	getResourceTransformation()	Returns a transformation for a newly created resource.
Optional<ResourceOperationRuntimeHandler>	getRuntimeHandler()	Returns the optional runtime handling for this resource.
OperationStepHandler	getWriteAttributeOperationStepHandler(AttributeDefinition attribute)	Returns custom operation handler for the specified attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getResourceDescriptionResolver

public ResourceDescriptionResolver getResourceDescriptionResolver()

Description copied from interface: ResourceDescriptor

The description resolver for the operation.

Specified by:

getResourceDescriptionResolver in interface ResourceDescriptor

Returns:

a description resolver

getRuntimeHandler

public Optional<ResourceOperationRuntimeHandler> getRuntimeHandler()

Description copied from interface: OperationStepHandlerDescriptor

Returns the optional runtime handling for this resource.

Specified by:

getRuntimeHandler in interface OperationStepHandlerDescriptor

Returns:

an optional runtime handler

getCapabilities

public Set<RuntimeCapability<?>> getCapabilities()

Description copied from interface: ResourceDescriptor

The capabilities provided by this resource

Specified by:

getCapabilities in interface ResourceDescriptor

Returns:

a set of capabilities

getCapabilityFilter

public BiPredicate<OperationContext,Resource> getCapabilityFilter(RuntimeCapability<?> capability)

Description copied from interface: OperationStepHandlerDescriptor

Returns the resource model filter used to determine whether the specified capability should be [un]registered.

Specified by:

getCapabilityFilter in interface OperationStepHandlerDescriptor

Parameters:

capability - a runtime capability

Returns:

a resource model predicate

getResourceCapabilityReferences

public Set<ResourceCapabilityReferenceRecorder<?>> getResourceCapabilityReferences()

Description copied from interface: ResourceDescriptor

Returns a mapping of capability references to an ancestor resource.

Specified by:

getResourceCapabilityReferences in interface ResourceDescriptor

Returns:

a tuple of capability references and requirement resolvers.

getResourceOperationTransformation

public UnaryOperator<OperationStepHandler> getResourceOperationTransformation()

Description copied from interface: ResourceDescriptor

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:

getResourceOperationTransformation in interface ResourceDescriptor

Returns:

an operation handler transformer.

getAttributes

public Iterable<AttributeDefinition> getAttributes()

Description copied from interface: ResourceDescriptor

Attributes of the the resource affecting runtime.

Specified by:

getAttributes in interface ResourceDescriptor

Returns:

a collection of attributes

getAttributeTranslation

public AttributeTranslation getAttributeTranslation(AttributeDefinition attribute)

Description copied from interface: AddResourceOperationStepHandlerDescriptor

Returns the attribute translation for the specified attribute, or null if none exists

Specified by:

getAttributeTranslation in interface AddResourceOperationStepHandlerDescriptor

Returns:

an attribute translation, or null if none exists

getWriteAttributeOperationStepHandler

public OperationStepHandler getWriteAttributeOperationStepHandler(AttributeDefinition attribute)

Description copied from interface: ResourceDescriptor

Returns custom operation handler for the specified attribute.

Specified by:

getWriteAttributeOperationStepHandler in interface ResourceDescriptor

Returns:

a "write-attribute" operation handler

getRequiredChildren

public Set<PathElement> getRequiredChildren()

Description copied from interface: AddResourceOperationStepHandlerDescriptor

Returns the required child resources for this resource description.

Specified by:

getRequiredChildren in interface AddResourceOperationStepHandlerDescriptor

Returns:

a collection of resource paths

getRequiredSingletonChildren

public Set<PathElement> getRequiredSingletonChildren()

Description copied from interface: AddResourceOperationStepHandlerDescriptor

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 AddResourceOperationStepHandlerDescriptor

Returns:

a collection of resource paths

getAddOperationTransformation

public UnaryOperator<OperationStepHandler> getAddOperationTransformation()

Description copied from interface: ResourceDescriptor

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 ResourceDescriptor

Returns:

an operation handler transformer.

getResourceTransformation

public UnaryOperator<Resource> getResourceTransformation()

Description copied from interface: AddResourceOperationStepHandlerDescriptor

Returns a transformation for a newly created resource.

Specified by:

getResourceTransformation in interface AddResourceOperationStepHandlerDescriptor

Returns:

a resource transformation

getDeploymentChainContributor

public Optional<Consumer<DeploymentProcessorTarget>> getDeploymentChainContributor()

Description copied from interface: AddResourceOperationStepHandlerDescriptor

Returns an optional consumer of a DeploymentProcessorTarget, used to add deployment unit processors to the deployment chain.

Specified by:

getDeploymentChainContributor in interface AddResourceOperationStepHandlerDescriptor

Returns:

an optional DeploymentProcessorTarget consumer

getAddOperationRestartFlag

public OperationEntry.Flag getAddOperationRestartFlag()

Description copied from interface: ResourceDescriptor

Returns the restart flag for the "add"} operation of this resource.

Specified by:

getAddOperationRestartFlag in interface ResourceDescriptor

Returns:

an operation flag

getRemoveOperationRestartFlag

public OperationEntry.Flag getRemoveOperationRestartFlag()

Description copied from interface: ResourceDescriptor

Returns the restart flag for the "remove" operation of this resource.

Specified by:

getRemoveOperationRestartFlag in interface ResourceDescriptor

Returns:

an operation flag