org.jboss.as.controller

Interface CapabilityReferenceRecorder

All Known Implementing Classes:

CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder, CapabilityReferenceRecorder.ContextDependencyRecorder, CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder, CapabilityReferenceRecorder.ResourceNameCompositeDependencyRecorder

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.
static class	CapabilityReferenceRecorder.ResourceNameCompositeDependencyRecorder CapabilityReferenceRecorder.ResourceNameCompositeDependencyRecorder that determines the dependent capability from the OperationContext and resource name.

Method Summary

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

Method Detail

addCapabilityRequirements

@Deprecated
void addCapabilityRequirements(OperationContext context,
                                           String attributeName,
                                           String... attributeValues)

Deprecated. use @{link addCapabilityRequirements(OperationContext, Resource, String, String...)} instead

Registers capability requirement information to the given context.

Parameters:

context - the context

attributeName - the name of the attribute

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

addCapabilityRequirements

default 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

@Deprecated
void removeCapabilityRequirements(OperationContext context,
                                              String attributeName,
                                              String... attributeValues)

Deprecated.

Deregisters capability requirement information from the given context.

Parameters:

context - the context

attributeName - the name of the attribute

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

removeCapabilityRequirements

default 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
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