Package org.wildfly.subsystem.resource.capability

Interface ResourceCapabilityReferenceRecorder<T>

All Superinterfaces:

CapabilityReferenceRecorder, CapabilityReferenceRecorder<T>, Feature

All Known Implementing Classes:

ResourceCapabilityReferenceRecorder.AbstractResourceCapabilityServiceDescriptorReference, ResourceCapabilityReferenceRecorder.ResourceCapabilityServiceDescriptorReference

public interface ResourceCapabilityReferenceRecorder<T>
extends CapabilityReferenceRecorder<T>

A CapabilityReferenceRecorder specialization that records requirements of a resource, rather than an attribute.

Author:

Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResourceCapabilityReferenceRecorder.AbstractResourceCapabilityServiceDescriptorReference<T>
static interface	ResourceCapabilityReferenceRecorder.Builder<T>
static class	ResourceCapabilityReferenceRecorder.DefaultBuilder<T>
static interface	ResourceCapabilityReferenceRecorder.NaryBuilder<T>
static class	ResourceCapabilityReferenceRecorder.ResourceCapabilityServiceDescriptorReference<T>

Nested classes/interfaces inherited from interface org.jboss.as.controller.CapabilityReferenceRecorder

CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder, CapabilityReferenceRecorder.ContextDependencyRecorder, CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder, CapabilityReferenceRecorder.ResourceCapabilityReferenceRecorder

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

CapabilityReferenceRecorder.AbstractCapabilityServiceDescriptorReferenceRecorder<T>, CapabilityReferenceRecorder.CapabilityServiceDescriptorReferenceRecorder<T>, CapabilityReferenceRecorder.GrandparentAttributeProvider<T>, CapabilityReferenceRecorder.GrandparentPathProvider<T>, CapabilityReferenceRecorder.GreatGrandparentAttributeProvider<T>, CapabilityReferenceRecorder.GreatGrandparentPathProvider<T>, CapabilityReferenceRecorder.ParentAttributeProvider<T>, CapabilityReferenceRecorder.ParentPathProvider<T>, CapabilityReferenceRecorder.RequirementNameSegmentResolver

Method Summary

Modifier and Type	Method	Description
void	addCapabilityRequirements(OperationContext context, Resource resource)	Registers capability requirements for the specified resource.
default void	addCapabilityRequirements(OperationContext context, Resource resource, String attributeName, String... attributeValues)
static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T>	builder(RuntimeCapability<Void> capability, org.wildfly.service.descriptor.BinaryServiceDescriptor<T> requirement)	Creates a builder for a new reference between the specified capability and the specified requirement.
static <T> ResourceCapabilityReferenceRecorder.Builder<T>	builder(RuntimeCapability<Void> capability, org.wildfly.service.descriptor.NullaryServiceDescriptor<T> requirement)	Creates a builder for a new reference between the specified capability and the specified requirement.
static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T>	builder(RuntimeCapability<Void> capability, org.wildfly.service.descriptor.QuaternaryServiceDescriptor<T> requirement)	Creates a builder for a new reference between the specified capability and the specified requirement.
static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T>	builder(RuntimeCapability<Void> capability, org.wildfly.service.descriptor.TernaryServiceDescriptor<T> requirement)	Creates a builder for a new reference between the specified capability and the specified requirement.
static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T>	builder(RuntimeCapability<Void> capability, org.wildfly.service.descriptor.UnaryServiceDescriptor<T> requirement)	Creates a builder for a new reference between the specified capability and the specified requirement.
Function<PathAddress,String[]>	getRequirementNameResolver()	Returns the resolver of the requirement name from a path address.
void	removeCapabilityRequirements(OperationContext context, Resource resource)	Unregisters capability requirements for the specified resource.
default void	removeCapabilityRequirements(OperationContext context, Resource resource, String attributeName, String... attributeValues)

Methods inherited from interface org.jboss.as.controller.CapabilityReferenceRecorder

getRequirementPatternSegments, isDynamicDependent

Methods inherited from interface org.wildfly.subsystem.resource.capability.CapabilityReferenceRecorder

getBaseDependentName, getBaseRequirementName, getDependent, getRequirement

Methods inherited from interface org.jboss.as.controller.Feature

getStability

Method Detail

getRequirementNameResolver

Function<PathAddress,String[]> getRequirementNameResolver()

Returns the resolver of the requirement name from a path address.

Returns:

a requirement name resolver

addCapabilityRequirements

void addCapabilityRequirements(OperationContext context,
                               Resource resource)

Registers capability requirements for the specified resource.

Parameters:

context - the context

resource - the resource on which requirements are gathered

removeCapabilityRequirements

void removeCapabilityRequirements(OperationContext context,
                                  Resource resource)

Unregisters capability requirements for the specified resource.

Parameters:

context - the context

resource - the resource on which requirements were gathered

addCapabilityRequirements

default void addCapabilityRequirements(OperationContext context,
                                       Resource resource,
                                       String attributeName,
                                       String... attributeValues)

Specified by:

addCapabilityRequirements in interface CapabilityReferenceRecorder

removeCapabilityRequirements

default void removeCapabilityRequirements(OperationContext context,
                                          Resource resource,
                                          String attributeName,
                                          String... attributeValues)

Specified by:

removeCapabilityRequirements in interface CapabilityReferenceRecorder

builder

static <T> ResourceCapabilityReferenceRecorder.Builder<T> builder(RuntimeCapability<Void> capability,
                                                                  org.wildfly.service.descriptor.NullaryServiceDescriptor<T> requirement)

Creates a builder for a new reference between the specified capability and the specified requirement.

Parameters:

capability - the capability referencing the specified requirement

requirement - the requirement of the specified capability

builder

static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T> builder(RuntimeCapability<Void> capability,
                                                                      org.wildfly.service.descriptor.UnaryServiceDescriptor<T> requirement)

Creates a builder for a new reference between the specified capability and the specified requirement. By default, the requirement name will resolve against the path of the current resource.

Parameters:

capability - the capability referencing the specified requirement

requirement - the requirement of the specified capability

builder

static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T> builder(RuntimeCapability<Void> capability,
                                                                      org.wildfly.service.descriptor.BinaryServiceDescriptor<T> requirement)

Creates a builder for a new reference between the specified capability and the specified requirement. By default, the requirement name will resolve against the paths of the parent and current resources, respectively.

Parameters:

capability - the capability referencing the specified requirement

requirement - the requirement of the specified capability

requirementNameResolver - function for resolving the dynamic components of the requirement name

builder

static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T> builder(RuntimeCapability<Void> capability,
                                                                      org.wildfly.service.descriptor.TernaryServiceDescriptor<T> requirement)

Creates a builder for a new reference between the specified capability and the specified requirement. By default, the requirement name will resolve against the paths of the grandparent, parent, and current resources, respectively.

Parameters:

capability - the capability referencing the specified requirement

requirement - the requirement of the specified capability

requirementNameResolver - function for resolving the dynamic components of the requirement name

builder

static <T> ResourceCapabilityReferenceRecorder.NaryBuilder<T> builder(RuntimeCapability<Void> capability,
                                                                      org.wildfly.service.descriptor.QuaternaryServiceDescriptor<T> requirement)

Creates a builder for a new reference between the specified capability and the specified requirement. By default, the requirement name will resolve against the paths of the great-grandparent, grandparent, parent, and current resources, respectively.

Parameters:

capability - the capability referencing the specified requirement

requirement - the requirement of the specified capability

requirementNameResolver - function for resolving the dynamic components of the requirement name