public interface ImmutableManagementResourceRegistration
ManagementResourceRegistration
.Modifier and Type | Field and Description |
---|---|
static Permission |
ACCESS_PERMISSION
A
ControllerPermission needed to create a ImmutableManagementResourceRegistration or invoke one
of its methods. |
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<RuntimeCapability> |
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
|
default 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.)
|
default 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.
|
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.
|
ImmutableManagementResourceRegistration |
getSubModel(PathAddress address)
Get a sub model registration.
|
boolean |
isAlias()
Gets whether this resource registration is an alias to another resource.
|
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.
|
static final Permission ACCESS_PERMISSION
ControllerPermission
needed to create a ImmutableManagementResourceRegistration
or invoke one
of its methods. The name of the permission is "canAccessImmutableManagementResourceRegistration
."PathAddress getPathAddress()
null
default int getMaxOccurs()
default int getMinOccurs()
boolean isRuntimeOnly()
true
if the model node has no representation in the
persistent configuration model; false
otherwiseSecurityException
- if the caller does not have ACCESS_PERMISSION
boolean isRemote()
true
if this registration represents a remote resource; false
otherwiseSecurityException
- if the caller does not have ACCESS_PERMISSION
boolean isAlias()
true
if this registration represents an alias; false
otherwiseSecurityException
- if the caller does not have ACCESS_PERMISSION
AliasEntry getAliasEntry()
null
otherwiseIllegalStateException
- if isAlias()
returns false
SecurityException
- if the caller does not have ACCESS_PERMISSION
OperationStepHandler getOperationHandler(PathAddress address, String operationName)
null
if none exists.address
- the address, relative to this nodeoperationName
- the operation nameSecurityException
- if the caller does not have ACCESS_PERMISSION
DescriptionProvider getOperationDescription(PathAddress address, String operationName)
null
if none exists.address
- the address, relative to this nodeoperationName
- the operation nameSecurityException
- if the caller does not have ACCESS_PERMISSION
Set<OperationEntry.Flag> getOperationFlags(PathAddress address, String operationName)
null
if none exist.address
- the address, relative to this nodeoperationName
- the operation namenull
SecurityException
- if the caller does not have ACCESS_PERMISSION
OperationEntry getOperationEntry(PathAddress address, String operationName)
null
if none exists.address
- the address, relative to this nodeoperationName
- the operation namenull
SecurityException
- if the caller does not have ACCESS_PERMISSION
Set<String> getAttributeNames(PathAddress address)
address
- the address, relative to this nodeSecurityException
- if the caller does not have ACCESS_PERMISSION
AttributeAccess getAttributeAccess(PathAddress address, String attributeName)
address
- the address of the resourceattributeName
- the name of the attributenull
if the attribute or address is unknownSecurityException
- if the caller does not have ACCESS_PERMISSION
Map<String,NotificationEntry> getNotificationDescriptions(PathAddress address, boolean inherited)
address
- the addressinherited
- true to include inherited notificationsSecurityException
- if the caller does not have ACCESS_PERMISSION
Set<String> getChildNames(PathAddress address)
address
- the address, relative to this nodeSecurityException
- if the caller does not have ACCESS_PERMISSION
Set<PathElement> getChildAddresses(PathAddress address)
address
- the address we want to find children forSecurityException
- if the caller does not have ACCESS_PERMISSION
DescriptionProvider getModelDescription(PathAddress address)
null
if none exists.address
- the address, relative to this nodeSecurityException
- if the caller does not have ACCESS_PERMISSION
Map<String,OperationEntry> getOperationDescriptions(PathAddress address, boolean inherited)
address
- the addressinherited
- true to include inherited operationsSecurityException
- if the caller does not have ACCESS_PERMISSION
ProxyController getProxyController(PathAddress address)
[a=b,c=d,e=f]
and there is a proxy registered under
[a=b,c=d]
that proxy will be returned.address
- the address to look for a proxy undernull
if there is noneSecurityException
- if the caller does not have ACCESS_PERMISSION
Set<ProxyController> getProxyControllers(PathAddress address)
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.address
- the address to start looking for proxies underSecurityException
- if the caller does not have ACCESS_PERMISSION
ImmutableManagementResourceRegistration getSubModel(PathAddress address)
address
- the address, relative to this nodenull
if there is noneSecurityException
- if the caller does not have ACCESS_PERMISSION
List<AccessConstraintDefinition> getAccessConstraints()
boolean isOrderedChildResource()
ManagementResourceRegistration.registerSubModel(ResourceDefinition)
, and false
otherwiseSet<String> getOrderedChildTypes()
Set<RuntimeCapability> getCapabilities()
Copyright © 2023 JBoss by Red Hat. All rights reserved.