Package org.jboss.as.controller.registry

Class DelegatingImmutableManagementResourceRegistration

java.lang.Object

org.jboss.as.controller.registry.DelegatingImmutableManagementResourceRegistration

All Implemented Interfaces:

FeatureFilter, FeatureRegistry, ImmutableManagementResourceRegistration

public class DelegatingImmutableManagementResourceRegistration
extends Object
implements ImmutableManagementResourceRegistration

ImmutableManagementResourceRegistration implementation that simply delegates to another ImmutableManagementResourceRegistration (typically a mutable implementation of sub-interface ManagementResourceRegistration).

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields inherited from interface org.jboss.as.controller.registry.ImmutableManagementResourceRegistration

ACCESS_PERMISSION

Constructor Summary

Constructors

Constructor	Description
DelegatingImmutableManagementResourceRegistration(ImmutableManagementResourceRegistration delegate)	Creates a new ImmutableManagementResourceRegistration.

Method Summary

Modifier and Type	Method	Description
<F extends Feature> boolean	enables(F feature)	Determines whether the specified feature is enabled by the configured stability level of the feature registry.
List<AccessConstraintDefinition>	getAccessConstraints()
Set<RuntimePackageDependency>	getAdditionalRuntimePackages()	Returns additional packages provided by this resource.
AliasEntry	getAliasEntry()	Gets the alias entry for this registration if it is an alias
AttributeAccess	getAttributeAccess(PathAddress address, String attributeName)	Gets the information on how to read from or write to the given attribute.
Set<String>	getAttributeNames(PathAddress address)	Get the names of the attributes for a node
Map<String,AttributeAccess>	getAttributes(PathAddress address)	Get the information about all attributes for a node.
Set<RuntimeCapability>	getCapabilities()	Returns all capabilities provided by this resource.
Set<PathElement>	getChildAddresses(PathAddress address)	Gets the set of direct child address elements under the node at the passed in PathAddress
Set<String>	getChildNames(PathAddress address)	Get the names of the types of children for a node
String	getFeature()
Set<RuntimeCapability>	getIncorporatingCapabilities()	Returns all capabilities provided by parents of this resource, to which this resource contributes.
int	getMaxOccurs()	Gets the maximum number of times a resource of the type described by this registration can occur under its parent resource (or, for a root resource, the minimum number of times it can occur at all.)
int	getMinOccurs()	Gets the minimum number of times a resource of the type described by this registration can occur under its parent resource (or, for a root resource, the number of times it can occur at all.)
DescriptionProvider	getModelDescription(PathAddress address)	Get the model description at the given address, or null if none exists.
Map<String,NotificationEntry>	getNotificationDescriptions(PathAddress address, boolean inherited)	Get a map of descriptions of all notifications emitted by the resources at an address.
DescriptionProvider	getOperationDescription(PathAddress address, String operationName)	Get the operation description at the given address, or null if none exists.
Map<String,OperationEntry>	getOperationDescriptions(PathAddress address, boolean inherited)	Get a map of descriptions of all operations available at an address.
OperationEntry	getOperationEntry(PathAddress address, String operationName)	Get the entry representing an operation registered with the given name at the given address, or null if none exists.
Set<OperationEntry.Flag>	getOperationFlags(PathAddress address, String operationName)	Get the special characteristic flags for the operation at the given address, or null if none exist.
OperationStepHandler	getOperationHandler(PathAddress address, String operationName)	Get the operation handler at the given address, or null if none exists.
Set<String>	getOrderedChildTypes()	Return the names of the child types registered to be ordered.
ImmutableManagementResourceRegistration	getParent()	Gets the registration for this resource type's parent, if there is one.
PathAddress	getPathAddress()	Gets the address under which we are registered.
ProcessType	getProcessType()	Gets the type of process in which this management resource type is registered.
ProxyController	getProxyController(PathAddress address)	If there is a proxy controller registered under any part of the registered address it will be returned.
Set<ProxyController>	getProxyControllers(PathAddress address)	Finds all proxy controllers registered at the passed in address, or at lower levels.
Set<CapabilityReferenceRecorder>	getRequirements()	Returns all capability reference recorders provided by this resource.
Stability	getStability()	Returns the feature stability supported by this feature registry.
ImmutableManagementResourceRegistration	getSubModel(PathAddress address)	Get a sub model registration.
boolean	isAlias()	Gets whether this resource registration is an alias to another resource.
boolean	isFeature()
boolean	isOrderedChildResource()	Return @code true} if a child resource registration was registered using ManagementResourceRegistration.registerSubModel(ResourceDefinition), and false otherwise
boolean	isRemote()	Gets whether operations against the resource represented by this registration will be proxied to a remote process.
boolean	isRuntimeOnly()	Gets whether this model node only exists in the runtime and has no representation in the persistent configuration model.

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingImmutableManagementResourceRegistration

public DelegatingImmutableManagementResourceRegistration(ImmutableManagementResourceRegistration delegate)

Creates a new ImmutableManagementResourceRegistration.

Parameters:

delegate - the delegate. Cannot be null

Method Details

getPathAddress

public PathAddress getPathAddress()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the address under which we are registered.

Specified by:

getPathAddress in interface ImmutableManagementResourceRegistration

Returns:

the address. Will not be null

getProcessType

public ProcessType getProcessType()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the type of process in which this management resource type is registered.

Specified by:

getProcessType in interface ImmutableManagementResourceRegistration

Returns:

the process type. Will not return null

getStability

public Stability getStability()

Description copied from interface: FeatureRegistry

Returns the feature stability supported by this feature registry.

Specified by:

getStability in interface FeatureRegistry

Returns:

a stability level

enables

public <F extends Feature> boolean enables(F feature)

Description copied from interface: FeatureRegistry

Determines whether the specified feature is enabled by the configured stability level of the feature registry.

Specified by:

enables in interface FeatureFilter

Specified by:

enables in interface FeatureRegistry

Type Parameters:

F - the feature type

Parameters:

feature - a feature

Returns:

true, if the specified feature is enabled, false otherwise.

getParent

public ImmutableManagementResourceRegistration getParent()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the registration for this resource type's parent, if there is one.

Specified by:

getParent in interface ImmutableManagementResourceRegistration

Returns:

the parent, or null if ImmutableManagementResourceRegistration.getPathAddress() returns an address with a size of 0

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the maximum number of times a resource of the type described by this registration can occur under its parent resource (or, for a root resource, the minimum number of times it can occur at all.)

Specified by:

getMaxOccurs in interface ImmutableManagementResourceRegistration

Returns:

the minimum number of occurrences

getMinOccurs

public int getMinOccurs()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the minimum number of times a resource of the type described by this registration can occur under its parent resource (or, for a root resource, the number of times it can occur at all.)

Specified by:

getMinOccurs in interface ImmutableManagementResourceRegistration

Returns:

the minimum number of occurrences

getFeature

public String getFeature()

Specified by:

getFeature in interface ImmutableManagementResourceRegistration

isFeature

public boolean isFeature()

Specified by:

isFeature in interface ImmutableManagementResourceRegistration

isRuntimeOnly

public boolean isRuntimeOnly()

Description copied from interface: ImmutableManagementResourceRegistration

Gets whether this model node only exists in the runtime and has no representation in the persistent configuration model.

Specified by:

isRuntimeOnly in interface ImmutableManagementResourceRegistration

Returns:

true if the model node has no representation in the persistent configuration model; false otherwise

isRemote

public boolean isRemote()

Description copied from interface: ImmutableManagementResourceRegistration

Gets whether operations against the resource represented by this registration will be proxied to a remote process.

Specified by:

isRemote in interface ImmutableManagementResourceRegistration

Returns:

true if this registration represents a remote resource; false otherwise

isAlias

public boolean isAlias()

Description copied from interface: ImmutableManagementResourceRegistration

Gets whether this resource registration is an alias to another resource.

Specified by:

isAlias in interface ImmutableManagementResourceRegistration

Returns:

true if this registration represents an alias; false otherwise

getOperationEntry

public OperationEntry getOperationEntry(PathAddress address,
 String operationName)

Description copied from interface: ImmutableManagementResourceRegistration

Get the entry representing an operation registered with the given name at the given address, or null if none exists.

Specified by:

getOperationEntry in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

operationName - the operation name

Returns:

the operation entry or null

getOperationHandler

public OperationStepHandler getOperationHandler(PathAddress address,
 String operationName)

Description copied from interface: ImmutableManagementResourceRegistration

Get the operation handler at the given address, or null if none exists.

Specified by:

getOperationHandler in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

operationName - the operation name

Returns:

the operation handler

getOperationDescription

public DescriptionProvider getOperationDescription(PathAddress address,
 String operationName)

Description copied from interface: ImmutableManagementResourceRegistration

Get the operation description at the given address, or null if none exists.

Specified by:

getOperationDescription in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

operationName - the operation name

Returns:

the operation description

getOperationFlags

public Set<OperationEntry.Flag> getOperationFlags(PathAddress address,
 String operationName)

Description copied from interface: ImmutableManagementResourceRegistration

Get the special characteristic flags for the operation at the given address, or null if none exist.

Specified by:

getOperationFlags in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

operationName - the operation name

Returns:

the operation entry flags or null

getAttributeNames

public Set<String> getAttributeNames(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Get the names of the attributes for a node

Specified by:

getAttributeNames in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the attribute names. If there are none an empty set is returned

getAttributeAccess

public AttributeAccess getAttributeAccess(PathAddress address,
 String attributeName)

Description copied from interface: ImmutableManagementResourceRegistration

Gets the information on how to read from or write to the given attribute.

Specified by:

getAttributeAccess in interface ImmutableManagementResourceRegistration

Parameters:

address - the address of the resource

attributeName - the name of the attribute

Returns:

the handling information, or null if the attribute or address is unknown

getAttributes

public Map<String,AttributeAccess> getAttributes(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Get the information about all attributes for a node.

Specified by:

getAttributes in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the attribute information, in a map keyed by attribute name. If there are none an empty map is returned

getChildNames

public Set<String> getChildNames(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Get the names of the types of children for a node

Specified by:

getChildNames in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the child type names. If there are none an empty set is returned

getChildAddresses

public Set<PathElement> getChildAddresses(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Gets the set of direct child address elements under the node at the passed in PathAddress

Specified by:

getChildAddresses in interface ImmutableManagementResourceRegistration

Parameters:

address - the address we want to find children for

Returns:

the set of direct child elements

getModelDescription

public DescriptionProvider getModelDescription(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Get the model description at the given address, or null if none exists.

Specified by:

getModelDescription in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the model description

getOperationDescriptions

public Map<String,OperationEntry> getOperationDescriptions(PathAddress address,
 boolean inherited)

Description copied from interface: ImmutableManagementResourceRegistration

Get a map of descriptions of all operations available at an address.

Specified by:

getOperationDescriptions in interface ImmutableManagementResourceRegistration

Parameters:

address - the address

inherited - true to include inherited operations

Returns:

the operation map

getNotificationDescriptions

public Map<String,NotificationEntry> getNotificationDescriptions(PathAddress address,
 boolean inherited)

Description copied from interface: ImmutableManagementResourceRegistration

Get a map of descriptions of all notifications emitted by the resources at an address.

Specified by:

getNotificationDescriptions in interface ImmutableManagementResourceRegistration

Parameters:

address - the address

inherited - true to include inherited notifications

Returns:

the notifications map

getProxyController

public ProxyController getProxyController(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

If there is a proxy controller registered under any part of the registered address it will be returned. E.g. if the address passed in is [a=b,c=d,e=f] and there is a proxy registered under [a=b,c=d] that proxy will be returned.

Specified by:

getProxyController in interface ImmutableManagementResourceRegistration

Parameters:

address - the address to look for a proxy under

Returns:

the found proxy controller, or null if there is none

getProxyControllers

public Set<ProxyController> getProxyControllers(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Finds all proxy controllers registered at the passed in address, or at lower levels.

E.g. if the address passed in is a=b and there are proxies registered at [a=b,c=d], [a=b,e=f] and [g-h], the proxies for [a=b,c=d] and [a=b,e=f] will be returned.

Specified by:

getProxyControllers in interface ImmutableManagementResourceRegistration

Parameters:

address - the address to start looking for proxies under

Returns:

the found proxy controllers, or an empty set if there are none

getSubModel

public ImmutableManagementResourceRegistration getSubModel(PathAddress address)

Description copied from interface: ImmutableManagementResourceRegistration

Get a sub model registration.

Specified by:

getSubModel in interface ImmutableManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the node registration, null if there is none

getAccessConstraints

public List<AccessConstraintDefinition> getAccessConstraints()

Specified by:

getAccessConstraints in interface ImmutableManagementResourceRegistration

getAliasEntry

public AliasEntry getAliasEntry()

Description copied from interface: ImmutableManagementResourceRegistration

Gets the alias entry for this registration if it is an alias

Specified by:

getAliasEntry in interface ImmutableManagementResourceRegistration

Returns:

the alias entry if this registration represents an aliased resource; null otherwise

isOrderedChildResource

public boolean isOrderedChildResource()

Description copied from interface: ImmutableManagementResourceRegistration

Return @code true} if a child resource registration was registered using ManagementResourceRegistration.registerSubModel(ResourceDefinition), and false otherwise

Specified by:

isOrderedChildResource in interface ImmutableManagementResourceRegistration

Returns:

whether this is an ordered child or not

getOrderedChildTypes

public Set<String> getOrderedChildTypes()

Description copied from interface: ImmutableManagementResourceRegistration

Return the names of the child types registered to be ordered.

Specified by:

getOrderedChildTypes in interface ImmutableManagementResourceRegistration

Returns:

the set of ordered child types, and and empty set if there are none

getCapabilities

public Set<RuntimeCapability> getCapabilities()

Description copied from interface: ImmutableManagementResourceRegistration

Returns all capabilities provided by this resource. This will only include capabilities for which this resource controls the registration of the capability. If any children of this resource are involved in providing the capability, the registration for the children must not include the capability in the value they return from this method.

Specified by:

getCapabilities in interface ImmutableManagementResourceRegistration

Returns:

Set of capabilities if any registered otherwise an empty set

See Also:

• ImmutableManagementResourceRegistration.getIncorporatingCapabilities()

getIncorporatingCapabilities

public Set<RuntimeCapability> getIncorporatingCapabilities()

Description copied from interface: ImmutableManagementResourceRegistration

Returns all capabilities provided by parents of this resource, to which this resource contributes. This will only include capabilities for which this resource does not control the registration of the capability. Any capabilities registered by this resource will instead be included in the return value for ImmutableManagementResourceRegistration.getCapabilities().

Often, this method will return null, which has a special meaning. A null value means this resource contributes to any capabilities provided by resources higher in its branch of the resource tree, with the search for such capabilities continuing through ancestor resources until:

1. The ancestor has registered a capability; i.e. once a capability is identified, higher levels are not searched
2. The ancestor returns a non-null value from this method; i.e. once an ancestor declares an incorporating capability or that there are no incorporating capabilities, higher levels are not searched
3. The ancestor is a root resource. Child resources do not contribute to root capabilities unless they specifically declare they do so
4. The ancestor has single element address whose key is host. Child resources do not contribute to host root capabilities unless they specifically declare they do so
5. For subsystem resources, the ancestor resource is not provided by the subsystem. Subsystem resources do not contribute to capabilities provided by the kernel

A non-null value indicates no search of parent resources for capabilities should be performed, and only those capabilities included in the return set should be considered as incorporating this resource (or none at all if the return set is empty.)

An instance of this interface that returns a non-empty set from ImmutableManagementResourceRegistration.getCapabilities() must not return null from this method. If a resource itself provides a capability but also contributes to a different capability provided by a parent, that relationship must be specifically noted in the return value from this method.

Note that providing a capability that is in turn a requirement of a parent resource's capability is not the kind of "contributing" to the parent resource's capability that is being considered here. The relationship between a capability and its requirements is separately tracked by the RuntimeCapability itself. A typical "contributing" resource would be one that represents a chunk of configuration directly used by the parent resource's capability.

Specified by:

getIncorporatingCapabilities in interface ImmutableManagementResourceRegistration

Returns:

set of capabilities, or null if default resolution of capabilities to which this resource contributes should be used; an empty set can be used to indicate this resource does not contribute to capabilities provided by its parent. Will not return null if ImmutableManagementResourceRegistration.getCapabilities() returns a non-empty set.

See Also:

• ImmutableManagementResourceRegistration.getCapabilities()

getRequirements

public Set<CapabilityReferenceRecorder> getRequirements()

Description copied from interface: ImmutableManagementResourceRegistration

Returns all capability reference recorders provided by this resource.

Specified by:

getRequirements in interface ImmutableManagementResourceRegistration

Returns:

Set of CapabilityReferenceRecorder if any registered otherwise an empty set.

getAdditionalRuntimePackages

public Set<RuntimePackageDependency> getAdditionalRuntimePackages()

Description copied from interface: ImmutableManagementResourceRegistration

Returns additional packages provided by this resource.

Specified by:

getAdditionalRuntimePackages in interface ImmutableManagementResourceRegistration

Returns:

Set of RuntimePackageDependency if any registered otherwise an empty set.