org.jboss.as.controller.registry

Class DelegatingManagementResourceRegistration

java.lang.Object

org.jboss.as.controller.registry.DelegatingManagementResourceRegistration

All Implemented Interfaces:

ImmutableManagementResourceRegistration, ManagementResourceRegistration

public class DelegatingManagementResourceRegistration
extends Object
implements ManagementResourceRegistration

ManagementResourceRegistration implementation that simply delegates to another ManagementResourceRegistration. 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) 2013 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DelegatingManagementResourceRegistration.RegistrationDelegateProvider Provides a delegate for use by a DelegatingManagementResourceRegistration.

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

ManagementResourceRegistration.Factory

Field Summary

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

ACCESS_PERMISSION

Constructor Summary

Constructors

Constructor and Description
DelegatingManagementResourceRegistration(DelegatingManagementResourceRegistration.RegistrationDelegateProvider delegateProvider) Creates a new DelegatingManagementResourceRegistration with a possibly changing delegate.
DelegatingManagementResourceRegistration(ManagementResourceRegistration delegate) Creates a new DelegatingManagementResourceRegistration with a fixed delegate.

Method Summary

Modifier and Type	Method and Description
List<AccessConstraintDefinition>	getAccessConstraints()
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
Set<Capability>	getCapabilities() Returns all capabilities defined for 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
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.
ManagementResourceRegistration	getOverrideModel(String name) Get a specifically named resource that overrides this wildcard registration by adding additional attributes, operations or child types.
PathAddress	getPathAddress() Gets the address under which we are 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.
ManagementResourceRegistration	getSubModel(PathAddress address) Get a sub model registration.
boolean	isAlias() Gets whether this resource registration is an alias to another resource.
boolean	isAllowsOverride() Gets whether this registration will always throw an exception if ManagementResourceRegistration.registerOverrideModel(String, OverrideDescriptionProvider) is invoked.
boolean	isOrderedChildResource() Return @code true} if a child resource registration was registered using #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.
void	registerAlias(PathElement address, AliasEntry aliasEntry) Register an alias registration to another part of the model
void	registerCapability(RuntimeCapability capability) Registers passed capability on resource
void	registerMetric(AttributeDefinition definition, OperationStepHandler metricHandler) Records that the given attribute is a metric.
void	registerNotification(NotificationDefinition notification) Record that the given notification can be emitted by this resource.
void	registerNotification(NotificationDefinition notification, boolean inherited) Record that the given notification can be emitted by this resource.
void	registerOperationHandler(OperationDefinition definition, OperationStepHandler handler) Register an operation handler for this resource.
void	registerOperationHandler(OperationDefinition definition, OperationStepHandler handler, boolean inherited) Register an operation handler for this resource.
ManagementResourceRegistration	registerOverrideModel(String name, OverrideDescriptionProvider descriptionProvider) Register a specifically named resource that overrides this wildcard registration by adding additional attributes, operations or child types.
void	registerProxyController(PathElement address, ProxyController proxyController) Register a proxy controller.
void	registerReadOnlyAttribute(AttributeDefinition definition, OperationStepHandler readHandler) Records that the given attribute can be read from but not written to, and optionally provides an operation handler for the read.
void	registerReadWriteAttribute(AttributeDefinition definition, OperationStepHandler readHandler, OperationStepHandler writeHandler) Records that the given attribute can be both read from and written to, and provides operation handlers for the read and the write.
ManagementResourceRegistration	registerSubModel(ResourceDefinition resourceDefinition) Register the existence of an addressable sub-resource of this resource.
void	setRuntimeOnly(boolean runtimeOnly) Sets whether this model node only exists in the runtime and has no representation in the persistent configuration model.
void	unregisterAlias(PathElement address) Unregister an alias
void	unregisterAttribute(String attributeName) Remove that the given attribute if present.
void	unregisterNotification(String notificationType) Remove that the given notification can be emitted by this resource.
void	unregisterOperationHandler(String operationName) Unregister an operation handler for this resource.
void	unregisterOverrideModel(String name) Unregister a specifically named resource that overrides a wildcard registration by adding additional attributes, operations or child types.
void	unregisterProxyController(PathElement address) Unregister a proxy controller
void	unregisterSubModel(PathElement address) Unregister the existence of an addressable sub-resource of this resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingManagementResourceRegistration

public DelegatingManagementResourceRegistration(ManagementResourceRegistration delegate)

Creates a new DelegatingManagementResourceRegistration with a fixed delegate.

Parameters:

delegate - the delegate. Cannot be null

DelegatingManagementResourceRegistration

public DelegatingManagementResourceRegistration(DelegatingManagementResourceRegistration.RegistrationDelegateProvider delegateProvider)

Creates a new DelegatingManagementResourceRegistration with a possibly changing delegate.

Parameters:

delegateProvider - provider of the delegate. Cannot be null

Method Detail

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

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

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

getOverrideModel

public ManagementResourceRegistration getOverrideModel(String name)

Description copied from interface: ManagementResourceRegistration

Get a specifically named resource that overrides this wildcard registration by adding additional attributes, operations or child types.

Specified by:

getOverrideModel in interface ManagementResourceRegistration

Parameters:

name - the specific name of the resource. Cannot be null or PathElement.WILDCARD_VALUE

Returns:

the resource registration, null if there is none

getSubModel

public ManagementResourceRegistration getSubModel(PathAddress address)

Description copied from interface: ManagementResourceRegistration

Get a sub model registration.

This method overrides the superinterface method of the same name in order to require that the returned registration be mutable.

Specified by:

getSubModel in interface ImmutableManagementResourceRegistration

Specified by:

getSubModel in interface ManagementResourceRegistration

Parameters:

address - the address, relative to this node

Returns:

the resource registration, null if there is none

registerSubModel

public ManagementResourceRegistration registerSubModel(ResourceDefinition resourceDefinition)

Description copied from interface: ManagementResourceRegistration

Register the existence of an addressable sub-resource of this resource. Before this method returns the provided resourceDefinition will be given the opportunity to register attributes, register operations, and register notifications

Specified by:

registerSubModel in interface ManagementResourceRegistration

Parameters:

resourceDefinition - source for descriptive information describing this portion of the model (must not be null)

Returns:

a resource registration which may be used to add attributes, operations, notifications and sub-models

unregisterSubModel

public void unregisterSubModel(PathElement address)

Description copied from interface: ManagementResourceRegistration

Unregister the existence of an addressable sub-resource of this resource.

Specified by:

unregisterSubModel in interface ManagementResourceRegistration

Parameters:

address - the child of this registry that should no longer be available

isAllowsOverride

public boolean isAllowsOverride()

Description copied from interface: ManagementResourceRegistration

Gets whether this registration will always throw an exception if ManagementResourceRegistration.registerOverrideModel(String, OverrideDescriptionProvider) is invoked. An exception will always be thrown for root resource registrations, non-wildcard registrations, or remote registrations.

Specified by:

isAllowsOverride in interface ManagementResourceRegistration

Returns:

true if an exception will not always be thrown; false if it will

setRuntimeOnly

public void setRuntimeOnly(boolean runtimeOnly)

Description copied from interface: ManagementResourceRegistration

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

Specified by:

setRuntimeOnly in interface ManagementResourceRegistration

Parameters:

runtimeOnly - true if the model node will have no representation in the persistent configuration model; false otherwise

registerOverrideModel

public ManagementResourceRegistration registerOverrideModel(String name,
                                                            OverrideDescriptionProvider descriptionProvider)

Description copied from interface: ManagementResourceRegistration

Register a specifically named resource that overrides this wildcard registration by adding additional attributes, operations or child types.

Specified by:

registerOverrideModel in interface ManagementResourceRegistration

Parameters:

name - the specific name of the resource. Cannot be null or PathElement.WILDCARD_VALUE

descriptionProvider - provider for descriptions of the additional attributes or child types

Returns:

a resource registration which may be used to add attributes, operations and sub-models

unregisterOverrideModel

public void unregisterOverrideModel(String name)

Description copied from interface: ManagementResourceRegistration

Unregister a specifically named resource that overrides a wildcard registration by adding additional attributes, operations or child types.

Specified by:

unregisterOverrideModel in interface ManagementResourceRegistration

Parameters:

name - the specific name of the resource. Cannot be null or PathElement.WILDCARD_VALUE

registerOperationHandler

public void registerOperationHandler(OperationDefinition definition,
                                     OperationStepHandler handler)

Description copied from interface: ManagementResourceRegistration

Register an operation handler for this resource.

Specified by:

registerOperationHandler in interface ManagementResourceRegistration

Parameters:

definition - the definition of operation

handler - the operation handler

registerOperationHandler

public void registerOperationHandler(OperationDefinition definition,
                                     OperationStepHandler handler,
                                     boolean inherited)

Description copied from interface: ManagementResourceRegistration

Register an operation handler for this resource.

Specified by:

registerOperationHandler in interface ManagementResourceRegistration

Parameters:

definition - the definition of operation

handler - the operation handler

inherited - true if the operation is inherited to child nodes, false otherwise

unregisterOperationHandler

public void unregisterOperationHandler(String operationName)

Description copied from interface: ManagementResourceRegistration

Unregister an operation handler for this resource.

Specified by:

unregisterOperationHandler in interface ManagementResourceRegistration

Parameters:

operationName - the operation name

registerReadWriteAttribute

public void registerReadWriteAttribute(AttributeDefinition definition,
                                       OperationStepHandler readHandler,
                                       OperationStepHandler writeHandler)

Description copied from interface: ManagementResourceRegistration

Records that the given attribute can be both read from and written to, and provides operation handlers for the read and the write. The attribute is assumed to be AttributeAccess.Storage.CONFIGURATION unless parameter flags includes AttributeAccess.Flag.STORAGE_RUNTIME.

Specified by:

registerReadWriteAttribute in interface ManagementResourceRegistration

Parameters:

definition - the attribute definition. Cannot be null

readHandler - the handler for attribute reads. May be null in which case the default handling is used

writeHandler - the handler for attribute writes. Cannot be null

registerReadOnlyAttribute

public void registerReadOnlyAttribute(AttributeDefinition definition,
                                      OperationStepHandler readHandler)

Description copied from interface: ManagementResourceRegistration

Records that the given attribute can be read from but not written to, and optionally provides an operation handler for the read. The attribute is assumed to be AttributeAccess.Storage.CONFIGURATION unless parameter flags includes AttributeAccess.Flag.STORAGE_RUNTIME.

Specified by:

registerReadOnlyAttribute in interface ManagementResourceRegistration

Parameters:

definition - the attribute definition. Cannot be null

readHandler - the handler for attribute reads. May be null in which case the default handling is used

registerMetric

public void registerMetric(AttributeDefinition definition,
                           OperationStepHandler metricHandler)

Description copied from interface: ManagementResourceRegistration

Records that the given attribute is a metric.

Specified by:

registerMetric in interface ManagementResourceRegistration

Parameters:

definition - the attribute definition. Cannot be null

metricHandler - the handler for attribute reads. Cannot be null

unregisterAttribute

public void unregisterAttribute(String attributeName)

Description copied from interface: ManagementResourceRegistration

Remove that the given attribute if present.

Specified by:

unregisterAttribute in interface ManagementResourceRegistration

Parameters:

attributeName - the name of the attribute. Cannot be null

registerNotification

public void registerNotification(NotificationDefinition notification,
                                 boolean inherited)

Description copied from interface: ManagementResourceRegistration

Record that the given notification can be emitted by this resource.

Specified by:

registerNotification in interface ManagementResourceRegistration

Parameters:

notification - the definition of the notification. Cannot be null

inherited - true if the notification is inherited to child nodes, false otherwise

registerNotification

public void registerNotification(NotificationDefinition notification)

Description copied from interface: ManagementResourceRegistration

Record that the given notification can be emitted by this resource. The notification is not inherited by child nodes.

Specified by:

registerNotification in interface ManagementResourceRegistration

Parameters:

notification - the definition of the notification. Cannot be null

unregisterNotification

public void unregisterNotification(String notificationType)

Description copied from interface: ManagementResourceRegistration

Remove that the given notification can be emitted by this resource.

Specified by:

unregisterNotification in interface ManagementResourceRegistration

Parameters:

notificationType - the type of the notification. Cannot be null

registerProxyController

public void registerProxyController(PathElement address,
                                    ProxyController proxyController)

Description copied from interface: ManagementResourceRegistration

Register a proxy controller.

Specified by:

registerProxyController in interface ManagementResourceRegistration

Parameters:

address - the child of this registry that should be proxied

proxyController - the proxy controller

unregisterProxyController

public void unregisterProxyController(PathElement address)

Description copied from interface: ManagementResourceRegistration

Unregister a proxy controller

Specified by:

unregisterProxyController in interface ManagementResourceRegistration

Parameters:

address - the child of this registry that should no longer be proxied

registerAlias

public void registerAlias(PathElement address,
                          AliasEntry aliasEntry)

Description copied from interface: ManagementResourceRegistration

Register an alias registration to another part of the model

Specified by:

registerAlias in interface ManagementResourceRegistration

Parameters:

address - the child of this registry that is an alias

aliasEntry - the target model

unregisterAlias

public void unregisterAlias(PathElement address)

Description copied from interface: ManagementResourceRegistration

Unregister an alias

Specified by:

unregisterAlias in interface ManagementResourceRegistration

Parameters:

address - the child of this registry that is an alias

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

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

isOrderedChildResource

public boolean isOrderedChildResource()

Description copied from interface: ImmutableManagementResourceRegistration

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

Specified by:

isOrderedChildResource in interface ImmutableManagementResourceRegistration

Returns:

whether this is an ordered child or not

registerCapability

public void registerCapability(RuntimeCapability capability)

Description copied from interface: ManagementResourceRegistration

Registers passed capability on resource

Specified by:

registerCapability in interface ManagementResourceRegistration

Parameters:

capability - a capability to register

getCapabilities

public Set<Capability> getCapabilities()

Description copied from interface: ImmutableManagementResourceRegistration

Returns all capabilities defined for this resource.

Specified by:

getCapabilities in interface ImmutableManagementResourceRegistration

Returns:

Set of capabilities if any registered otherwise empty set