public interface ManagementResourceRegistration extends ImmutableManagementResourceRegistration
Modifier and Type | Interface and Description |
---|---|
static class |
ManagementResourceRegistration.Factory
A factory for creating a new, root model node registration.
|
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.
|
getAttributeAccess, getAttributeNames, getChildAddresses, getChildNames, getModelDescription, getOperationDescription, getOperationDescriptions, getOperationEntry, getOperationFlags, getOperationHandler, getProxyController, getProxyControllers, isRemote, isRuntimeOnly
ManagementResourceRegistration getOverrideModel(String name)
wildcard registration
by adding additional attributes, operations or child types.name
- the specific name of the resource. Cannot be null
or PathElement.WILDCARD_VALUE
null
if there is noneManagementResourceRegistration getSubModel(PathAddress address)
This method overrides the superinterface method of the same name in order to require that the returned registration be mutable.
getSubModel
in interface ImmutableManagementResourceRegistration
address
- the address, relative to this nodenull
if there is noneManagementResourceRegistration registerSubModel(PathElement address, DescriptionProvider descriptionProvider)
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
)IllegalArgumentException
- if a submodel is already registered at address
IllegalStateException
- if ImmutableManagementResourceRegistration.isRuntimeOnly()
returns true
ManagementResourceRegistration registerSubModel(ResourceDefinition resourceDefinition)
resourceDefinition
will be given the opportunity to
register attributes
and register operations
.resourceDefinition
- source for descriptive information describing this
portion of the model (must not be null
)IllegalArgumentException
- if a submodel is already registered at address
IllegalStateException
- if ImmutableManagementResourceRegistration.isRuntimeOnly()
returns true
void unregisterSubModel(PathElement address)
address
- the child of this registry that should no longer be availableboolean isAllowsOverride()
registerOverrideModel(String, OverrideDescriptionProvider)
is invoked. An exception will always
be thrown for root resource registrations, non-wildcard registrations
, or
remote registrations
.true
if an exception will not always be thrown; false
if it willvoid setRuntimeOnly(boolean runtimeOnly)
runtimeOnly
- true
if the model node will have no representation in the
persistent configuration model; false
otherwiseManagementResourceRegistration registerOverrideModel(String name, OverrideDescriptionProvider descriptionProvider)
wildcard registration
by adding additional attributes, operations or child types.name
- the specific name of the resource. Cannot be null
or PathElement.WILDCARD_VALUE
descriptionProvider
- provider for descriptions of the additional attributes or child typesIllegalArgumentException
- if either parameter is null or if there is already a registration under name
IllegalStateException
- if ImmutableManagementResourceRegistration.isRuntimeOnly()
returns true
or if isAllowsOverride()
returns falsevoid unregisterOverrideModel(String name)
wildcard registration
by adding additional attributes, operations or child types.name
- the specific name of the resource. Cannot be null
or PathElement.WILDCARD_VALUE
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationIllegalArgumentException
- if either parameter is null
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, EnumSet<OperationEntry.Flag> flags)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationflags
- operational modifier flags for this operation (e.g. read-only)IllegalArgumentException
- if either parameter is null
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationinherited
- true
if the operation is inherited to child nodes, false
otherwiseIllegalArgumentException
- if either parameter is null
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, OperationEntry.EntryType entryType)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationinherited
- true
if the operation is inherited to child nodes, false
otherwiseentryType
- the operation entry typeIllegalArgumentException
- if either parameter is null
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, EnumSet<OperationEntry.Flag> flags)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationinherited
- true
if the operation is inherited to child nodes, false
otherwiseflags
- operational modifier flags for this operation (e.g. read-only)IllegalArgumentException
- if either parameter is null
void registerOperationHandler(String operationName, OperationStepHandler handler, DescriptionProvider descriptionProvider, boolean inherited, OperationEntry.EntryType entryType, EnumSet<OperationEntry.Flag> flags)
operationName
- the operation namehandler
- the operation handlerdescriptionProvider
- the description provider for this operationinherited
- true
if the operation is inherited to child nodes, false
otherwiseentryType
- the operation entry typeflags
- operational modifier flags for this operation (e.g. read-only)IllegalArgumentException
- if either parameter is null
void unregisterOperationHandler(String operationName)
operationName
- the operation nameIllegalArgumentException
- if operationName is not registeredvoid registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, AttributeAccess.Storage storage)
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 usedwriteHandler
- the handler for attribute writes. Cannot be null
storage
- the storage type for this attributeIllegalArgumentException
- if attributeName
or writeHandler
are null
void registerReadWriteAttribute(String attributeName, OperationStepHandler readHandler, OperationStepHandler writeHandler, EnumSet<AttributeAccess.Flag> flags)
AttributeAccess.Storage.CONFIGURATION
unless parameter
flags
includes AttributeAccess.Flag.STORAGE_RUNTIME
.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 usedwriteHandler
- the handler for attribute writes. Cannot be null
flags
- additional flags describing this attributeIllegalArgumentException
- if attributeName
or writeHandler
are null
void registerReadWriteAttribute(AttributeDefinition definition, OperationStepHandler readHandler, OperationStepHandler writeHandler)
AttributeAccess.Storage.CONFIGURATION
unless parameter
flags
includes AttributeAccess.Flag.STORAGE_RUNTIME
.definition
- the attribute definition. Cannot be null
readHandler
- the handler for attribute reads. May be null
in which case the default handling is usedwriteHandler
- the handler for attribute writes. Cannot be null
IllegalArgumentException
- if definition
or writeHandler
are null
void registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, AttributeAccess.Storage storage)
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 usedstorage
- the storage type for this attributeIllegalArgumentException
- if attributeName
is null
void registerReadOnlyAttribute(String attributeName, OperationStepHandler readHandler, EnumSet<AttributeAccess.Flag> flags)
AttributeAccess.Storage.CONFIGURATION
unless parameter
flags
includes AttributeAccess.Flag.STORAGE_RUNTIME
.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 usedflags
- additional flags describing this attributeIllegalArgumentException
- if attributeName
is null
void registerReadOnlyAttribute(AttributeDefinition definition, OperationStepHandler readHandler)
AttributeAccess.Storage.CONFIGURATION
unless parameter
flags
includes AttributeAccess.Flag.STORAGE_RUNTIME
.definition
- the attribute definition. Cannot be null
readHandler
- the handler for attribute reads. May be null
in which case the default handling is usedIllegalArgumentException
- if definition
is null
void registerMetric(String attributeName, OperationStepHandler metricHandler)
attributeName
- the name of the attribute. Cannot be null
metricHandler
- the handler for attribute reads. Cannot be null
IllegalArgumentException
- if attributeName
or metricHandler
are null
void registerMetric(AttributeDefinition definition, OperationStepHandler metricHandler)
definition
- the attribute definition. Cannot be null
metricHandler
- the handler for attribute reads. Cannot be null
IllegalArgumentException
- if definition
or metricHandler
are null
void registerMetric(String attributeName, OperationStepHandler metricHandler, EnumSet<AttributeAccess.Flag> flags)
attributeName
- the name of the attribute. Cannot be null
metricHandler
- the handler for attribute reads. Cannot be null
flags
- additional flags describing this attributeIllegalArgumentException
- if attributeName
or metricHandler
are null
void unregisterAttribute(String attributeName)
attributeName
- the name of the attribute. Cannot be null
void registerProxyController(PathElement address, ProxyController proxyController)
address
- the child of this registry that should be proxiedproxyController
- the proxy controllervoid unregisterProxyController(PathElement address)
address
- the child of this registry that should no longer be proxiedCopyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.