org.jboss.as.controller

Interface CapabilityReferenceRecorder

All Known Implementing Classes:

CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder, CapabilityReferenceRecorder.ContextDependencyRecorder, CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder

public interface CapabilityReferenceRecorder

Records information about capability reference information encoded in an attribute's value.

Author:

Brian Stansberry (c) 2015 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder CapabilityReferenceRecorder that determines the dependent capability from the OperationContext and any additional attributes on same resource.
static class	CapabilityReferenceRecorder.ContextDependencyRecorder CapabilityReferenceRecorder that determines the dependent capability from the OperationContext.
static class	CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder Default implementation of CapabilityReferenceRecorder.

Method Summary

Modifier and Type	Method and Description
void	addCapabilityRequirements(OperationContext context, Resource resource, String attributeName, String... attributeValues) Registers capability requirement information to the given context.
String	getBaseDependentName() Deprecated. No longer required and may throw UnsupportedOperationException
String	getBaseRequirementName()
default boolean	isDynamicDependent() Deprecated. No longer required and may throw UnsupportedOperationException
void	removeCapabilityRequirements(OperationContext context, Resource resource, String attributeName, String... attributeValues) Deregisters capability requirement information from the given context.

Method Detail

addCapabilityRequirements

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

Registers capability requirement information to the given context.

Parameters:

context - the context

resource - the resource on which requirements are gathered

attributeName - the name of the attribute

attributeValues - the values of the attribute, which may contain null

removeCapabilityRequirements

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

Deregisters capability requirement information from the given context.

Parameters:

context - the context

resource - the resource on which requirements are gathered

attributeName - the name of the attribute

attributeValues - the values of the attribute, which may contain null

getBaseDependentName

@Deprecated
String getBaseDependentName()

Deprecated. No longer required and may throw UnsupportedOperationException

Returns:

base name of dependant, usually name of the attribute that provides reference to capability

getBaseRequirementName

String getBaseRequirementName()

Returns:

requirement name of the capability this reference depends on

isDynamicDependent

@Deprecated
default boolean isDynamicDependent()

Deprecated. No longer required and may throw UnsupportedOperationException

Returns:

tells is reference is dynamic or static, in case where it is dynamic it uses base name + name of dependent attribute to construct name of capability