Package org.wildfly.subsystem.resource

Interface ResourceDescriptor

All Superinterfaces:

AddResourceOperationStepHandlerDescriptor, OperationStepHandlerDescriptor

All Known Implementing Classes:

ResourceDescriptor.DefaultResourceDescriptor

public interface ResourceDescriptor
extends AddResourceOperationStepHandlerDescriptor

An external description of a management resource, including its attributes, capabilities, etc.

Author:

Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResourceDescriptor.AbstractConfigurator<C extends ResourceDescriptor.Configurator<C>>	An abstract ResourceDescriptor configurator.
static interface	ResourceDescriptor.Builder	Builds a ResourceDescriptor.
static interface	ResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>	Configures the characteristics of a ResourceDescriptor.
static class	ResourceDescriptor.DefaultBuilder	An default ResourceDescriptor builder.
static class	ResourceDescriptor.DefaultResourceDescriptor	Default ResourceDescriptor implementation.

Method Summary

Modifier and Type	Method	Description
static ResourceDescriptor.Builder	builder(ResourceDescriptionResolver resolver)	Returns a ResourceDescriptor builder.
default OperationEntry.Flag	getAddOperationRestartFlag()	Returns the restart flag for the "add"} operation of this resource.
default UnaryOperator<OperationStepHandler>	getAddOperationTransformation()	Returns a transformer for the add operation handler.
default Iterable<AttributeDefinition>	getAttributes()	Attributes of the the resource affecting runtime.
default Set<RuntimeCapability<?>>	getCapabilities()	The capabilities provided by this resource
default OperationEntry.Flag	getRemoveOperationRestartFlag()	Returns the restart flag for the "remove" operation of this resource.
default Set<ResourceCapabilityReferenceRecorder<?>>	getResourceCapabilityReferences()	Returns a mapping of capability references to an ancestor resource.
ResourceDescriptionResolver	getResourceDescriptionResolver()	The description resolver for the operation.
default UnaryOperator<OperationStepHandler>	getResourceOperationTransformation()	Returns a transformer to be applied to all operations that operate on an existing resource.
default OperationStepHandler	getWriteAttributeOperationStepHandler(AttributeDefinition attribute)	Returns custom operation handler for the specified attribute.
static <T,P extends Supplier<T>> Stream<T>	stream(Collection<P> providers)	Convenience method that exposes a collection of Suppliers as a stream of their supplied values.

Methods inherited from interface org.wildfly.subsystem.resource.operation.AddResourceOperationStepHandlerDescriptor

getAttributeTranslation, getDeploymentChainContributor, getRequiredChildren, getRequiredSingletonChildren, getResourceTransformation

Methods inherited from interface org.wildfly.subsystem.resource.operation.OperationStepHandlerDescriptor

getCapabilityFilter, getRuntimeHandler

Method Detail

builder

static ResourceDescriptor.Builder builder(ResourceDescriptionResolver resolver)

Returns a ResourceDescriptor builder. The returned builder is not thread-safe and should not be modified by multiple threads.

Parameters:

resolver - a description resolver for this resource

Returns:

a description of this resource

stream

static <T,P extends Supplier<T>> Stream<T> stream(Collection<P> providers)

Convenience method that exposes a collection of Suppliers as a stream of their supplied values.

Type Parameters:

T - the supplied value type

P - the provider type

Returns:

a stream of attribute definitions.

getResourceDescriptionResolver

ResourceDescriptionResolver getResourceDescriptionResolver()

The description resolver for the operation.

Returns:

a description resolver

getResourceCapabilityReferences

default Set<ResourceCapabilityReferenceRecorder<?>> getResourceCapabilityReferences()

Returns a mapping of capability references to an ancestor resource.

Returns:

a tuple of capability references and requirement resolvers.

getResourceOperationTransformation

default UnaryOperator<OperationStepHandler> getResourceOperationTransformation()

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.

Returns:

an operation handler transformer.

getAttributes

default Iterable<AttributeDefinition> getAttributes()

Attributes of the the resource affecting runtime.

Returns:

a collection of attributes

getWriteAttributeOperationStepHandler

default OperationStepHandler getWriteAttributeOperationStepHandler(AttributeDefinition attribute)

Returns custom operation handler for the specified attribute.

Returns:

a "write-attribute" operation handler

getCapabilities

default Set<RuntimeCapability<?>> getCapabilities()

The capabilities provided by this resource

Returns:

a set of capabilities

getAddOperationTransformation

default UnaryOperator<OperationStepHandler> getAddOperationTransformation()

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.

Returns:

an operation handler transformer.

getAddOperationRestartFlag

default OperationEntry.Flag getAddOperationRestartFlag()

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

Returns:

an operation flag

getRemoveOperationRestartFlag

default OperationEntry.Flag getRemoveOperationRestartFlag()

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

Returns:

an operation flag