org.jboss.as.controller.registry

Interface ManagementResourceRegistration

All Superinterfaces:

ImmutableManagementResourceRegistration

public interface ManagementResourceRegistration
extends ImmutableManagementResourceRegistration

A registration for a management resource which consists of a resource description plus registered operation handlers.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ManagementResourceRegistration.Factory A factory for creating a new, root model node registration.

Method Summary

Methods

Modifier and Type	Method and Description
ManagementResourceRegistration	getOverrideModel(String name) Get a specifically named resource that overrides this wildcard registration by adding additional attributes, operations or child types.
ManagementResourceRegistration	getSubModel(PathAddress address) Get a sub model registration.
boolean	isAllowsOverride() Gets whether this registration will always throw an exception if registerOverrideModel(String, OverrideDescriptionProvider) is invoked.
void	registerMetric(AttributeDefinition definition, OperationStepHandler metricHandler) Records that the given attribute is a metric.
void	registerMetric(String attributeName, OperationStepHandler metricHandler) Records that the given attribute is a metric.
void	registerMetric(String attributeName, OperationStepHandler metricHandler, EnumSet<AttributeAccess.Flag> flags) Records that the given attribute is a metric.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider) Register an operation handler for this resource.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited) Register an operation handler for this resource.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, EnumSet<OperationEntry.Flag> flags) Register an operation handler for this resource.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, OperationEntry.EntryType entryType) Register an operation handler for this resource.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, OperationEntry.EntryType entryType, EnumSet<OperationEntry.Flag> flags) Register an operation handler for this resource.
void	registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, EnumSet<OperationEntry.Flag> flags) 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	registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, AttributeAccess.Storage storage) Records that the given attribute can be read from but not written to, and optionally provides an operation handler for the read.
void	registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, EnumSet<AttributeAccess.Flag> flags) 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.
void	registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, AttributeAccess.Storage storage) Records that the given attribute can be both read from and written to, and provides operation handlers for the read and the write.
void	registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, EnumSet<AttributeAccess.Flag> flags) 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(PathElement address, DescriptionProvider descriptionProvider) Register the existence of an addressable sub-resource of this resource.
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	unregisterAttribute(String attributeName) Remove that the given attribute if present.
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 interface org.jboss.as.controller.registry.ImmutableManagementResourceRegistration

getAttributeAccess, getAttributeNames, getChildAddresses, getChildNames, getModelDescription, getOperationDescription, getOperationDescriptions, getOperationEntry, getOperationFlags, getOperationHandler, getProxyController, getProxyControllers, isRemote, isRuntimeOnly

Method Detail

getOverrideModel

ManagementResourceRegistration getOverrideModel(String name)

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

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

ManagementResourceRegistration getSubModel(PathAddress address)

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

Parameters:

address - the address, relative to this node

Returns:

the resource registration, null if there is none

registerSubModel

ManagementResourceRegistration registerSubModel(PathElement address,
                                              DescriptionProvider descriptionProvider)

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

Parameters:

address - the address of the submodel (may include a wildcard)

descriptionProvider - 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 and sub-models

Throws:

IllegalArgumentException - if a submodel is already registered at address

IllegalStateException - if ImmutableManagementResourceRegistration.isRuntimeOnly() returns true

registerSubModel

ManagementResourceRegistration registerSubModel(ResourceDefinition resourceDefinition)

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 and register operations.

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 and sub-models

Throws:

IllegalArgumentException - if a submodel is already registered at address

IllegalStateException - if ImmutableManagementResourceRegistration.isRuntimeOnly() returns true

unregisterSubModel

void unregisterSubModel(PathElement address)

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

Parameters:

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

isAllowsOverride

boolean isAllowsOverride()

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

Returns:

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

setRuntimeOnly

void setRuntimeOnly(boolean runtimeOnly)

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

Parameters:

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

registerOverrideModel

ManagementResourceRegistration registerOverrideModel(String name,
                                                   OverrideDescriptionProvider descriptionProvider)

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

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

Throws:

IllegalArgumentException - if either parameter is null or if there is already a registration under name

IllegalStateException - if ImmutableManagementResourceRegistration.isRuntimeOnly() returns true or if isAllowsOverride() returns false

unregisterOverrideModel

void unregisterOverrideModel(String name)

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

Parameters:

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

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

Throws:

IllegalArgumentException - if either parameter is null

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider,
                            EnumSet<OperationEntry.Flag> flags)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

flags - operational modifier flags for this operation (e.g. read-only)

Throws:

IllegalArgumentException - if either parameter is null

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider,
                            boolean inherited)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

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

Throws:

IllegalArgumentException - if either parameter is null

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider,
                            boolean inherited,
                            OperationEntry.EntryType entryType)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

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

entryType - the operation entry type

Throws:

IllegalArgumentException - if either parameter is null

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider,
                            boolean inherited,
                            EnumSet<OperationEntry.Flag> flags)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

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

flags - operational modifier flags for this operation (e.g. read-only)

Throws:

IllegalArgumentException - if either parameter is null

registerOperationHandler

void registerOperationHandler(String operationName,
                            OperationStepHandler handler,
                            DescriptionProvider descriptionProvider,
                            boolean inherited,
                            OperationEntry.EntryType entryType,
                            EnumSet<OperationEntry.Flag> flags)

Register an operation handler for this resource.

Parameters:

operationName - the operation name

handler - the operation handler

descriptionProvider - the description provider for this operation

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

entryType - the operation entry type

flags - operational modifier flags for this operation (e.g. read-only)

Throws:

IllegalArgumentException - if either parameter is null

unregisterOperationHandler

void unregisterOperationHandler(String operationName)

Unregister an operation handler for this resource.

Parameters:

operationName - the operation name

Throws:

IllegalArgumentException - if operationName is not registered

registerReadWriteAttribute

void registerReadWriteAttribute(String attributeName,
                              OperationStepHandler readHandler,
                              OperationStepHandler writeHandler,
                              AttributeAccess.Storage storage)

Records that the given attribute can be both read from and written to, and provides operation handlers for the read and the write.

Parameters:

attributeName - the name of the attribute. 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

storage - the storage type for this attribute

Throws:

IllegalArgumentException - if attributeName or writeHandler are null

registerReadWriteAttribute

void registerReadWriteAttribute(String attributeName,
                              OperationStepHandler readHandler,
                              OperationStepHandler writeHandler,
                              EnumSet<AttributeAccess.Flag> flags)

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.

Parameters:

attributeName - the name of the attribute. 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

flags - additional flags describing this attribute

Throws:

IllegalArgumentException - if attributeName or writeHandler are null

registerReadWriteAttribute

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. The attribute is assumed to be AttributeAccess.Storage.CONFIGURATION unless parameter flags includes AttributeAccess.Flag.STORAGE_RUNTIME.

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

Throws:

IllegalArgumentException - if definition or writeHandler are null

registerReadOnlyAttribute

void registerReadOnlyAttribute(String attributeName,
                             OperationStepHandler readHandler,
                             AttributeAccess.Storage storage)

Records that the given attribute can be read from but not written to, and optionally provides an operation handler for the read.

Parameters:

attributeName - the name of the attribute. Cannot be null

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

storage - the storage type for this attribute

Throws:

IllegalArgumentException - if attributeName is null

registerReadOnlyAttribute

void registerReadOnlyAttribute(String attributeName,
                             OperationStepHandler readHandler,
                             EnumSet<AttributeAccess.Flag> flags)

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.

Parameters:

attributeName - the name of the attribute. Cannot be null

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

flags - additional flags describing this attribute

Throws:

IllegalArgumentException - if attributeName is null

registerReadOnlyAttribute

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. The attribute is assumed to be AttributeAccess.Storage.CONFIGURATION unless parameter flags includes AttributeAccess.Flag.STORAGE_RUNTIME.

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

Throws:

IllegalArgumentException - if definition is null

registerMetric

void registerMetric(String attributeName,
                  OperationStepHandler metricHandler)

Records that the given attribute is a metric.

Parameters:

attributeName - the name of the attribute. Cannot be null

metricHandler - the handler for attribute reads. Cannot be null

Throws:

IllegalArgumentException - if attributeName or metricHandler are null

registerMetric

void registerMetric(AttributeDefinition definition,
                  OperationStepHandler metricHandler)

Records that the given attribute is a metric.

Parameters:

definition - the attribute definition. Cannot be null

metricHandler - the handler for attribute reads. Cannot be null

Throws:

IllegalArgumentException - if definition or metricHandler are null

registerMetric

void registerMetric(String attributeName,
                  OperationStepHandler metricHandler,
                  EnumSet<AttributeAccess.Flag> flags)

Records that the given attribute is a metric.

Parameters:

attributeName - the name of the attribute. Cannot be null

metricHandler - the handler for attribute reads. Cannot be null

flags - additional flags describing this attribute

Throws:

IllegalArgumentException - if attributeName or metricHandler are null

unregisterAttribute

void unregisterAttribute(String attributeName)

Remove that the given attribute if present.

Parameters:

attributeName - the name of the attribute. Cannot be null

registerProxyController

void registerProxyController(PathElement address,
                           ProxyController proxyController)

Register a proxy controller.

Parameters:

address - the child of this registry that should be proxied

proxyController - the proxy controller

unregisterProxyController

void unregisterProxyController(PathElement address)

Unregister a proxy controller

Parameters:

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