org.jboss.as.controller

Class CapabilityReferenceRecorder.ContextDependencyRecorder

java.lang.Object

org.jboss.as.controller.CapabilityReferenceRecorder.ContextDependencyRecorder

All Implemented Interfaces:

CapabilityReferenceRecorder

Direct Known Subclasses:

CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder

Enclosing interface:

CapabilityReferenceRecorder

public static class CapabilityReferenceRecorder.ContextDependencyRecorder
extends Object
implements CapabilityReferenceRecorder

CapabilityReferenceRecorder that determines the dependent capability from the OperationContext. This assumes that the resource registration associated with currently executing step will expose a capability set including one and only one capability. This recorder cannot be used with attributes associated with resources that do not meet this requirement.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ContextDependencyRecorder(String baseRequirementName)

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.
void	addCapabilityRequirements(OperationContext context, String attributeName, String... attributeValues) Registers capability requirement information to the given context.
String	getBaseDependentName() Throws UnsupportedOperationException
String	getBaseRequirementName()
protected RuntimeCapability	getDependentCapability(OperationContext context)
protected String	getDependentName(RuntimeCapability cap, OperationContext context)
protected String	getRequirementName(OperationContext context, Resource resource, String attributeValue)
boolean	isDynamicDependent() Throws UnsupportedOperationException
protected void	processCapabilityRequirement(OperationContext context, Resource resource, String attributeName, boolean remove, String... attributeValues)
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) Deregisters capability requirement information from the given context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextDependencyRecorder

public ContextDependencyRecorder(String baseRequirementName)

Method Detail

addCapabilityRequirements

public void addCapabilityRequirements(OperationContext context,
                                      String attributeName,
                                      String... attributeValues)

Description copied from interface: CapabilityReferenceRecorder

Registers capability requirement information to the given context.

Specified by:

addCapabilityRequirements in interface CapabilityReferenceRecorder

Parameters:

context - the context

attributeName - the name of the attribute

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

removeCapabilityRequirements

public void removeCapabilityRequirements(OperationContext context,
                                         String attributeName,
                                         String... attributeValues)

Description copied from interface: CapabilityReferenceRecorder

Deregisters capability requirement information from the given context.

Specified by:

removeCapabilityRequirements in interface CapabilityReferenceRecorder

Parameters:

context - the context

attributeName - the name of the attribute

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

addCapabilityRequirements

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

Registers capability requirement information to the given context.

Specified by:

addCapabilityRequirements in interface CapabilityReferenceRecorder

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

Throws:

AssertionError - if the requirements discussed in the class javadoc are not fulfilled

removeCapabilityRequirements

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

Deregisters capability requirement information from the given context.

Specified by:

removeCapabilityRequirements in interface CapabilityReferenceRecorder

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

Throws:

AssertionError - if the requirements discussed in the class javadoc are not fulfilled

processCapabilityRequirement

protected void processCapabilityRequirement(OperationContext context,
                                            Resource resource,
                                            String attributeName,
                                            boolean remove,
                                            String... attributeValues)

getDependentCapability

protected RuntimeCapability getDependentCapability(OperationContext context)

getDependentName

protected String getDependentName(RuntimeCapability cap,
                                  OperationContext context)

getRequirementName

protected String getRequirementName(OperationContext context,
                                    Resource resource,
                                    String attributeValue)

getBaseDependentName

public String getBaseDependentName()

Throws UnsupportedOperationException

Specified by:

getBaseDependentName in interface CapabilityReferenceRecorder

Returns:

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

getBaseRequirementName

public String getBaseRequirementName()

Specified by:

getBaseRequirementName in interface CapabilityReferenceRecorder

Returns:

requirement name of the capability this reference depends on

isDynamicDependent

public boolean isDynamicDependent()

Throws UnsupportedOperationException

Specified by:

isDynamicDependent in interface CapabilityReferenceRecorder

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