Package org.wildfly.subsystem.resource

Class ResourceDescriptor.AbstractConfigurator<C extends ResourceDescriptor.Configurator<C>>

java.lang.Object

org.wildfly.subsystem.resource.ResourceDescriptor.AbstractConfigurator<C>

All Implemented Interfaces:

ResourceDescriptor.Configurator<C>

Direct Known Subclasses:

ResourceDescriptor.DefaultBuilder

Enclosing interface:

ResourceDescriptor

public abstract static class ResourceDescriptor.AbstractConfigurator<C extends ResourceDescriptor.Configurator<C>>
extends Object
implements ResourceDescriptor.Configurator<C>

An abstract ResourceDescriptor configurator.

Method Summary

Modifier and Type	Method	Description
C	addAttribute(AttributeDefinition attribute, OperationStepHandler writeAttributeHandler)	Adds the attribute with the specified custom "write-attribute" operation handler.
C	addAttributes(Collection<AttributeDefinition> attributes)	Adds the specified attributes to this resource descriptor.
C	addCapabilities(Collection<RuntimeCapability<?>> capabilities, BiPredicate<OperationContext,Resource> filter)	Adds the specified runtime capabilities to this resource.
C	addCapability(RuntimeCapability<?> capability, BiPredicate<OperationContext,Resource> filter)	Adds the specified conditionally-registered runtime capability to this resource
C	addModelOnlyAttributes(Collection<AttributeDefinition> attributes)	Adds the specified model-only attributes (i.e.
C	addReadOnlyAttributes(Collection<AttributeDefinition> attributes)	Adds the specified read-only attributes to this resource descriptor.
C	addResourceCapabilityReferences(Collection<ResourceCapabilityReferenceRecorder<?>> references)	Adds a number of capability references that records requirements for this resource.
<P extends Supplier<AttributeDefinition>> C	provideAttributes(Collection<P> providers)	Adds the specified attribute providers to this resource descriptor.
<P extends Supplier<RuntimeCapability<?>>> C	provideCapabilities(Collection<P> providers, BiPredicate<OperationContext,Resource> filter)	Adds the specified conditionally-registered runtime capability providers to this resource descriptor.
<P extends Supplier<AttributeDefinition>> C	provideModelOnlyAttributes(Collection<P> providers)	Adds the specified model-only attribute providers to this resource descriptor.
<P extends Supplier<AttributeDefinition>> C	provideReadOnlyAttributes(Collection<P> providers)	Adds the specified read-only attribute providers to this resource descriptor.
<P extends Supplier<PathElement>> C	provideRequiredChildren(Collection<P> providers)	Defines a set of required children of this resource.
<P extends Supplier<PathElement>> C	provideRequiredSingletonChildren(Collection<P> providers)	Defines a set of required singleton children of this resource.
C	requireChildren(Set<PathElement> paths)	Defines a set of required children of this resource.
C	requireSingletonChildren(Set<PathElement> paths)	Defines a set of required singleton children of this resource.
protected abstract C	self()
C	translateAttribute(AttributeDefinition attribute, AttributeTranslation translation)	Specifies an attribute alias to another attribute of a potentially different resource.
C	withAddOperationRestartFlag(OperationEntry.Flag restartFlag)	Overrides the default restart flag for the "add" operation of this resource.
C	withAddResourceOperationTransformation(UnaryOperator<OperationStepHandler> transformation)	Applies the specified transformation to the "add" operation of this resource.
C	withDeploymentChainContributor(Consumer<DeploymentProcessorTarget> contributor)	Applies the specified deployment chain contributor to this resource's "add" operation.
C	withOperationTransformation(UnaryOperator<OperationStepHandler> transformation)	Applies the specified transformation to the "remove" and all global operations of this resource.
C	withRemoveOperationRestartFlag(OperationEntry.Flag restartFlag)	Overrides the default restart flag for the "remove" operation of this resource.
C	withResourceTransformation(UnaryOperator<Resource> transformation)	Applies the specified transformation to the Resource created by this resource's "add" operation.
C	withRuntimeHandler(ResourceOperationRuntimeHandler runtimeHandler)	Applies the specified runtime handler to the operations of this resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.subsystem.resource.ResourceDescriptor.Configurator

addCapabilities, addCapability, addResourceCapabilityReference, provideCapabilities, renameAttribute, requireChild, requireSingletonChild

Method Detail

self

protected abstract C self()

withRuntimeHandler

public C withRuntimeHandler(ResourceOperationRuntimeHandler runtimeHandler)

Description copied from interface: ResourceDescriptor.Configurator

Applies the specified runtime handler to the operations of this resource.

Specified by:

withRuntimeHandler in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

runtimeHandler - a runtime handler.

Returns:

a reference to this configurator

withAddOperationRestartFlag

public C withAddOperationRestartFlag(OperationEntry.Flag restartFlag)

Description copied from interface: ResourceDescriptor.Configurator

Overrides the default restart flag for the "add" operation of this resource.

Specified by:

withAddOperationRestartFlag in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

restartFlag - a restart flag

Returns:

a reference to this configurator

withRemoveOperationRestartFlag

public C withRemoveOperationRestartFlag(OperationEntry.Flag restartFlag)

Description copied from interface: ResourceDescriptor.Configurator

Overrides the default restart flag for the "remove" operation of this resource.

Specified by:

withRemoveOperationRestartFlag in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

restartFlag - a restart flag

Returns:

a reference to this configurator

addAttributes

public C addAttributes(Collection<AttributeDefinition> attributes)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified attributes to this resource descriptor.

Specified by:

addAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

attributes - a collection of attributes

Returns:

a reference to this configurator

addAttribute

public C addAttribute(AttributeDefinition attribute,
                      OperationStepHandler writeAttributeHandler)

Description copied from interface: ResourceDescriptor.Configurator

Adds the attribute with the specified custom "write-attribute" operation handler.

Specified by:

addAttribute in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

attribute - an attribute

writeAttributeHandler - custom "write-attribute" operation handler

Returns:

a reference to this configurator

addModelOnlyAttributes

public C addModelOnlyAttributes(Collection<AttributeDefinition> attributes)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified model-only attributes (i.e. with no runtime handling) to this resource descriptor.

Specified by:

addModelOnlyAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

attributes - a collection of attributes

Returns:

a reference to this configurator

addReadOnlyAttributes

public C addReadOnlyAttributes(Collection<AttributeDefinition> attributes)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified read-only attributes to this resource descriptor.

Specified by:

addReadOnlyAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

attributes - a collection of attributes

Returns:

a reference to this configurator

translateAttribute

public C translateAttribute(AttributeDefinition attribute,
                            AttributeTranslation translation)

Description copied from interface: ResourceDescriptor.Configurator

Specifies an attribute alias to another attribute of a potentially different resource.

Specified by:

translateAttribute in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

attribute - the alias attribute

translation - a description of the attribute translation

Returns:

a reference to this configurator

addCapability

public C addCapability(RuntimeCapability<?> capability,
                       BiPredicate<OperationContext,Resource> filter)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified conditionally-registered runtime capability to this resource

Specified by:

addCapability in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

capability - a runtime capability

filter - a predicate used to determine when the specified capability should be registered

Returns:

a reference to this configurator

addCapabilities

public C addCapabilities(Collection<RuntimeCapability<?>> capabilities,
                         BiPredicate<OperationContext,Resource> filter)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified runtime capabilities to this resource.

Specified by:

addCapabilities in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

capabilities - a collection of runtime capabilities

filter - a predicate used to determine when the specified capability should be registered

Returns:

a reference to this configurator

requireChildren

public C requireChildren(Set<PathElement> paths)

Description copied from interface: ResourceDescriptor.Configurator

Defines a set of required children of this resource. Required children will be automatically added, if no child resource exists with the specified path.

Specified by:

requireChildren in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

paths - a set of paths of the required child resources

Returns:

a reference to this configurator

requireSingletonChildren

public C requireSingletonChildren(Set<PathElement> paths)

Description copied from interface: ResourceDescriptor.Configurator

Defines a set of required singleton children of this resource. Required singleton children will be automatically added, if no child resource exists with the same path key.

Specified by:

requireSingletonChildren in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

paths - a set of paths of the required singleton child resources

Returns:

a reference to this configurator

addResourceCapabilityReferences

public C addResourceCapabilityReferences(Collection<ResourceCapabilityReferenceRecorder<?>> references)

Description copied from interface: ResourceDescriptor.Configurator

Adds a number of capability references that records requirements for this resource.

Specified by:

addResourceCapabilityReferences in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

references - a collection of capability reference recorders

Returns:

a reference to this configurator

withAddResourceOperationTransformation

public C withAddResourceOperationTransformation(UnaryOperator<OperationStepHandler> transformation)

Description copied from interface: ResourceDescriptor.Configurator

Applies the specified transformation to the "add" operation of this resource.

Specified by:

withAddResourceOperationTransformation in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

transformation - an operation handler transformation

Returns:

a reference to this configurator

withOperationTransformation

public C withOperationTransformation(UnaryOperator<OperationStepHandler> transformation)

Description copied from interface: ResourceDescriptor.Configurator

Applies the specified transformation to the "remove" and all global operations of this resource.

Specified by:

withOperationTransformation in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

transformation - an operation handler transformation

Returns:

a reference to this configurator

withResourceTransformation

public C withResourceTransformation(UnaryOperator<Resource> transformation)

Description copied from interface: ResourceDescriptor.Configurator

Applies the specified transformation to the Resource created by this resource's "add" operation.

Specified by:

withResourceTransformation in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

transformation - an operation handler transformation

Returns:

a reference to this configurator

withDeploymentChainContributor

public C withDeploymentChainContributor(Consumer<DeploymentProcessorTarget> contributor)

Description copied from interface: ResourceDescriptor.Configurator

Applies the specified deployment chain contributor to this resource's "add" operation.

Specified by:

withDeploymentChainContributor in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

contributor - a deployment chain contribution

Returns:

a reference to this configurator

provideAttributes

public <P extends Supplier<AttributeDefinition>> C provideAttributes(Collection<P> providers)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified attribute providers to this resource descriptor.

Specified by:

provideAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a collection of attribute providers

Returns:

a reference to this configurator

provideModelOnlyAttributes

public <P extends Supplier<AttributeDefinition>> C provideModelOnlyAttributes(Collection<P> providers)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified model-only attribute providers to this resource descriptor.

Specified by:

provideModelOnlyAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a collection of attribute providers

Returns:

a reference to this configurator

provideReadOnlyAttributes

public <P extends Supplier<AttributeDefinition>> C provideReadOnlyAttributes(Collection<P> providers)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified read-only attribute providers to this resource descriptor.

Specified by:

provideReadOnlyAttributes in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a collection of attribute providers

Returns:

a reference to this configurator

provideCapabilities

public <P extends Supplier<RuntimeCapability<?>>> C provideCapabilities(Collection<P> providers,
                                                                        BiPredicate<OperationContext,Resource> filter)

Description copied from interface: ResourceDescriptor.Configurator

Adds the specified conditionally-registered runtime capability providers to this resource descriptor.

Specified by:

provideCapabilities in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a collection of runtime capability providers

filter - a predicate used to determine when the specified capability should be registered

Returns:

a reference to this configurator

provideRequiredChildren

public <P extends Supplier<PathElement>> C provideRequiredChildren(Collection<P> providers)

Description copied from interface: ResourceDescriptor.Configurator

Defines a set of required children of this resource. Required children will be automatically added, if no child resource exists with the specified path.

Specified by:

provideRequiredChildren in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a set of providers of the required child resource paths

Returns:

a reference to this configurator

provideRequiredSingletonChildren

public <P extends Supplier<PathElement>> C provideRequiredSingletonChildren(Collection<P> providers)

Description copied from interface: ResourceDescriptor.Configurator

Defines a set of required singleton children of this resource. Required singleton children will be automatically added, if no child resource exists with the same path key.

Specified by:

provideRequiredSingletonChildren in interface ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>

Parameters:

providers - a set of providers of the required singleton child resource paths

Returns:

a reference to this configurator