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 classResourceDescriptor.AbstractConfigurator<C extends ResourceDescriptor.Configurator<C>>An abstractResourceDescriptorconfigurator.static interfaceResourceDescriptor.BuilderBuilds aResourceDescriptor.static interfaceResourceDescriptor.Configurator<C extends ResourceDescriptor.Configurator<C>>Configures the characteristics of aResourceDescriptor.static classResourceDescriptor.DefaultBuilderAn defaultResourceDescriptorbuilder.static classResourceDescriptor.DefaultResourceDescriptorDefaultResourceDescriptorimplementation.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static ResourceDescriptor.Builderbuilder(org.jboss.as.controller.descriptions.ResourceDescriptionResolver resolver)Returns aResourceDescriptorbuilder.default org.jboss.as.controller.registry.OperationEntry.FlaggetAddOperationRestartFlag()Returns the restart flag for the "add"} operation of this resource.default UnaryOperator<org.jboss.as.controller.OperationStepHandler>getAddOperationTransformation()Deprecated, for removal: This API element is subject to removal in a future version.Superseded bygetOperationTransformation(String)default Iterable<org.jboss.as.controller.AttributeDefinition>getAttributes()Attributes of the the resource affecting runtime.default Set<org.jboss.as.controller.capability.RuntimeCapability<?>>getCapabilities()The capabilities provided by this resourcedefault UnaryOperator<org.jboss.as.controller.OperationStepHandler>getOperationTransformation(String operationName)Returns a transformer to be applied the specified operation.default org.jboss.as.controller.registry.OperationEntry.FlaggetRemoveOperationRestartFlag()Returns the restart flag for the "remove" operation of this resource.default Set<ResourceCapabilityReference<?>>getResourceCapabilityReferences()Returns a mapping of capability references to an ancestor resource.org.jboss.as.controller.descriptions.ResourceDescriptionResolvergetResourceDescriptionResolver()The description resolver for the operation.default UnaryOperator<org.jboss.as.controller.OperationStepHandler>getResourceOperationTransformation()Deprecated, for removal: This API element is subject to removal in a future version.Superseded bygetOperationTransformation(String).default org.jboss.as.controller.OperationStepHandlergetWriteAttributeOperationStepHandler(org.jboss.as.controller.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, getRequiredChildResources, getRequiredSingletonChildren, getRequiredSingletonChildResources, getResourceTransformation
-
Methods inherited from interface org.wildfly.subsystem.resource.operation.OperationStepHandlerDescriptor
getCapabilityFilter, getRuntimeHandler
-
-
-
-
Method Detail
-
builder
static ResourceDescriptor.Builder builder(org.jboss.as.controller.descriptions.ResourceDescriptionResolver resolver)
Returns aResourceDescriptorbuilder. 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 typeP- the provider type- Returns:
- a stream of attribute definitions.
-
getResourceDescriptionResolver
org.jboss.as.controller.descriptions.ResourceDescriptionResolver getResourceDescriptionResolver()
The description resolver for the operation.- Returns:
- a description resolver
-
getResourceCapabilityReferences
default Set<ResourceCapabilityReference<?>> getResourceCapabilityReferences()
Returns a mapping of capability references to an ancestor resource.- Returns:
- a tuple of capability references and requirement resolvers.
-
getResourceOperationTransformation
@Deprecated(forRemoval=true, since="26.0.0") default UnaryOperator<org.jboss.as.controller.OperationStepHandler> getResourceOperationTransformation()
Deprecated, for removal: This API element is subject to removal in a future version.Superseded bygetOperationTransformation(String).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.
-
getOperationTransformation
default UnaryOperator<org.jboss.as.controller.OperationStepHandler> getOperationTransformation(String operationName)
Returns a transformer to be applied the specified operation. 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<org.jboss.as.controller.AttributeDefinition> getAttributes()
Attributes of the the resource affecting runtime.- Returns:
- a collection of attributes
-
getWriteAttributeOperationStepHandler
default org.jboss.as.controller.OperationStepHandler getWriteAttributeOperationStepHandler(org.jboss.as.controller.AttributeDefinition attribute)
Returns custom operation handler for the specified attribute.- Returns:
- a "write-attribute" operation handler
-
getCapabilities
default Set<org.jboss.as.controller.capability.RuntimeCapability<?>> getCapabilities()
The capabilities provided by this resource- Returns:
- a set of capabilities
-
getAddOperationTransformation
@Deprecated(forRemoval=true, since="26.0.0") default UnaryOperator<org.jboss.as.controller.OperationStepHandler> getAddOperationTransformation()
Deprecated, for removal: This API element is subject to removal in a future version.Superseded bygetOperationTransformation(String)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 org.jboss.as.controller.registry.OperationEntry.Flag getAddOperationRestartFlag()
Returns the restart flag for the "add"} operation of this resource.- Returns:
- an operation flag
-
getRemoveOperationRestartFlag
default org.jboss.as.controller.registry.OperationEntry.Flag getRemoveOperationRestartFlag()
Returns the restart flag for the "remove" operation of this resource.- Returns:
- an operation flag
-
-