org.jboss.as.controller.capability.registry

Interface CapabilityRegistry<C extends CapabilityRegistration,R extends RequirementRegistration>

Type Parameters:

C - the specific type of capability that can be registered

All Known Subinterfaces:

RuntimeCapabilityRegistry

All Known Implementing Classes:

DelegatingRuntimeCapabilityRegistry

public interface CapabilityRegistry<C extends CapabilityRegistration,R extends RequirementRegistration>

Registry of capabilities available in the system.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasCapability(String capabilityName, CapabilityContext context) Gets whether a capability with the given name is registered.
void	registerAdditionalCapabilityRequirement(R requirement) Registers an additional requirement a capability has beyond what it was aware of when capability was passed to registerCapability(CapabilityRegistration).
void	registerCapability(C capability) Registers a capability with the system.
C	removeCapability(String capabilityName, CapabilityContext context, PathAddress registrationPoint) Remove a previously registered capability if all registration points for it have been removed.
void	removeCapabilityRequirement(R requirement) Remove a previously registered requirement for a capability.

Method Detail

registerCapability

void registerCapability(C capability)

Registers a capability with the system. Any requirements associated with the capability will be recorded as requirements.

Parameters:

capability - the capability. Cannot be null

registerAdditionalCapabilityRequirement

void registerAdditionalCapabilityRequirement(R requirement)

Registers an additional requirement a capability has beyond what it was aware of when capability was passed to registerCapability(CapabilityRegistration). Used for cases where a capability optionally depends on another capability, and whether or not that requirement is needed is not known when the capability is first registered.

Parameters:

requirement - the requirement

Throws:

IllegalArgumentException - if no matching capability is currently registered for either required or dependent

removeCapabilityRequirement

void removeCapabilityRequirement(R requirement)

Remove a previously registered requirement for a capability.

Parameters:

requirement - the requirement. Cannot be null

See Also:

registerAdditionalCapabilityRequirement(org.jboss.as.controller.capability.registry.RequirementRegistration)

removeCapability

C removeCapability(String capabilityName,
                 CapabilityContext context,
                 PathAddress registrationPoint)

Remove a previously registered capability if all registration points for it have been removed.

Parameters:

capabilityName - the name of the capability. Cannot be null

context - the context in which the capability is registered. Cannot be null

registrationPoint - the specific registration point that is being removed

Returns:

the capability that was removed, or null if no matching capability was registered or other registration points for the capability still exist

hasCapability

boolean hasCapability(String capabilityName,
                    CapabilityContext context)

Gets whether a capability with the given name is registered.

Parameters:

capabilityName - the name of the capability. Cannot be null

context - the context in which to check for the capability

Returns:

true if there is a capability with the given name registered