org.jboss.as.controller.capability.registry

Class DelegatingRuntimeCapabilityRegistry

java.lang.Object

org.jboss.as.controller.capability.registry.DelegatingRuntimeCapabilityRegistry

All Implemented Interfaces:

CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>, RuntimeCapabilityRegistry

public class DelegatingRuntimeCapabilityRegistry
extends Object
implements RuntimeCapabilityRegistry

RuntimeCapabilityRegistry implementation that simply delegates to another RuntimeCapabilityRegistry. Intended as a convenience class to allow overriding of standard behaviors and also as a means to support a copy-on-write/publish-on-commit semantic for the management resource tree.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DelegatingRuntimeCapabilityRegistry.CapabilityRegistryDelegateProvider Provides a delegate for use by a DelegatingCapabilityRegistry.

Constructor Summary

Constructors

Constructor and Description
DelegatingRuntimeCapabilityRegistry(DelegatingRuntimeCapabilityRegistry.CapabilityRegistryDelegateProvider delegateProvider) Creates a new DelegatingResource with a possibly changing delegate.
DelegatingRuntimeCapabilityRegistry(RuntimeCapabilityRegistry delegate) Creates a new DelegatingCapabilityRegistry with a fixed delegate.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getCapabilityRuntimeAPI(String capabilityName, CapabilityContext context, Class<T> apiType) Gets the runtime API associated with a given capability, if there is one.
boolean	hasCapability(String capabilityName, CapabilityContext context) Gets whether a capability with the given name is registered.
void	registerAdditionalCapabilityRequirement(RuntimeRequirementRegistration requirementRegistration) Registers an additional requirement a capability has beyond what it was aware of when capability was passed to CapabilityRegistry.registerCapability(CapabilityRegistration).
void	registerCapability(RuntimeCapabilityRegistration capability) Registers a capability with the system.
RuntimeCapabilityRegistration	removeCapability(String capability, CapabilityContext context) Remove a previously registered capability.
void	removeCapabilityRequirement(RequirementRegistration requirementRegistration) Remove a previously registered requirement for a capability.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingRuntimeCapabilityRegistry

public DelegatingRuntimeCapabilityRegistry(RuntimeCapabilityRegistry delegate)

Creates a new DelegatingCapabilityRegistry with a fixed delegate.

Parameters:

delegate - the delegate. Cannot be null

DelegatingRuntimeCapabilityRegistry

public DelegatingRuntimeCapabilityRegistry(DelegatingRuntimeCapabilityRegistry.CapabilityRegistryDelegateProvider delegateProvider)

Creates a new DelegatingResource with a possibly changing delegate.

Parameters:

delegateProvider - provider of the delegate. Cannot be null

Method Detail

registerCapability

public void registerCapability(RuntimeCapabilityRegistration capability)

Description copied from interface: CapabilityRegistry

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

Specified by:

registerCapability in interface CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>

Parameters:

capability - the capability. Cannot be null

registerAdditionalCapabilityRequirement

public void registerAdditionalCapabilityRequirement(RuntimeRequirementRegistration requirementRegistration)

Description copied from interface: CapabilityRegistry

Registers an additional requirement a capability has beyond what it was aware of when capability was passed to CapabilityRegistry.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.

Specified by:

registerAdditionalCapabilityRequirement in interface CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>

Parameters:

requirementRegistration - the requirement

removeCapabilityRequirement

public void removeCapabilityRequirement(RequirementRegistration requirementRegistration)

Description copied from interface: CapabilityRegistry

Remove a previously registered requirement for a capability.

Specified by:

removeCapabilityRequirement in interface CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>

Parameters:

requirementRegistration - the requirement. Cannot be null

See Also:

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

removeCapability

public RuntimeCapabilityRegistration removeCapability(String capability,
                                             CapabilityContext context)

Description copied from interface: CapabilityRegistry

Remove a previously registered capability.

Specified by:

removeCapability in interface CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>

Parameters:

capability - the name of the capability. Cannot be null

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

Returns:

the capability that was removed, or null if no matching capability was registered

hasCapability

public boolean hasCapability(String capabilityName,
                    CapabilityContext context)

Description copied from interface: CapabilityRegistry

Gets whether a capability with the given name is registered.

Specified by:

hasCapability in interface CapabilityRegistry<RuntimeCapabilityRegistration,RuntimeRequirementRegistration>

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

getCapabilityRuntimeAPI

public <T> T getCapabilityRuntimeAPI(String capabilityName,
                            CapabilityContext context,
                            Class<T> apiType)

Description copied from interface: RuntimeCapabilityRegistry

Gets the runtime API associated with a given capability, if there is one.

Specified by:

getCapabilityRuntimeAPI in interface RuntimeCapabilityRegistry

Type Parameters:

T - the java type that exposes the API

Parameters:

capabilityName - the name of the capability. Cannot be null

context - the context in which to resolve the capability. Cannot be null

apiType - class of the java type that exposes the API. Cannot be null

Returns:

the runtime API. Will not return null