Class DelegatingManagementResourceRegistration
- java.lang.Object
-
- org.jboss.as.controller.registry.DelegatingManagementResourceRegistration
-
- All Implemented Interfaces:
ImmutableManagementResourceRegistration,ManagementResourceRegistration
public class DelegatingManagementResourceRegistration extends Object implements ManagementResourceRegistration
ManagementResourceRegistrationimplementation that simply delegates to anotherManagementResourceRegistration. 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 Description static interfaceDelegatingManagementResourceRegistration.RegistrationDelegateProviderProvides a delegate for use by aDelegatingManagementResourceRegistration.-
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 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AccessConstraintDefinition>getAccessConstraints()Set<RuntimePackageDependency>getAdditionalRuntimePackages()Returns additional packages provided by this resource.AliasEntrygetAliasEntry()Gets the alias entry for this registration if it is an aliasAttributeAccessgetAttributeAccess(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 nodeMap<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 PathAddressSet<String>getChildNames(PathAddress address)Get the names of the types of children for a nodeStringgetFeature()Set<RuntimeCapability>getIncorporatingCapabilities()Returns all capabilities provided by parents of this resource, to which this resource contributes.intgetMaxOccurs()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.)intgetMinOccurs()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.)DescriptionProvidergetModelDescription(PathAddress address)Get the model description at the given address, ornullif 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.DescriptionProvidergetOperationDescription(PathAddress address, String operationName)Get the operation description at the given address, ornullif none exists.Map<String,OperationEntry>getOperationDescriptions(PathAddress address, boolean inherited)Get a map of descriptions of all operations available at an address.OperationEntrygetOperationEntry(PathAddress address, String operationName)Get the entry representing an operation registered with the given name at the given address, ornullif none exists.Set<OperationEntry.Flag>getOperationFlags(PathAddress address, String operationName)Get the special characteristic flags for the operation at the given address, ornullif none exist.OperationStepHandlergetOperationHandler(PathAddress address, String operationName)Get the operation handler at the given address, ornullif none exists.Set<String>getOrderedChildTypes()Return the names of the child types registered to be ordered.ManagementResourceRegistrationgetOverrideModel(String name)Get a specifically named resource that overrides thiswildcard registrationby adding additional attributes, operations or child types.ImmutableManagementResourceRegistrationgetParent()Gets the registration for this resource type's parent, if there is one.PathAddressgetPathAddress()Gets the address under which we are registered.ProcessTypegetProcessType()Gets the type of process in which this management resource type is registered.ProxyControllergetProxyController(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.ManagementResourceRegistrationgetSubModel(PathAddress address)Get a sub model registration.booleanisAlias()Gets whether this resource registration is an alias to another resource.booleanisAllowsOverride()Gets whether this registration will always throw an exception ifManagementResourceRegistration.registerOverrideModel(String, OverrideDescriptionProvider)is invoked.booleanisFeature()booleanisOrderedChildResource()Return @code true} if a child resource registration was registered usingManagementResourceRegistration.registerSubModel(ResourceDefinition), andfalseotherwisebooleanisRemote()Gets whether operations against the resource represented by this registration will be proxied to a remote process.booleanisRuntimeOnly()Gets whether this model node only exists in the runtime and has no representation in the persistent configuration model.voidregisterAdditionalRuntimePackages(RuntimePackageDependency... pkgs)RegisterRuntimePackageDependencyadditional packages.voidregisterAlias(PathElement address, AliasEntry aliasEntry)Register an alias registration to another part of the modelvoidregisterCapability(RuntimeCapability capability)Registers passed capability on resourcevoidregisterIncorporatingCapabilities(Set<RuntimeCapability> capabilities)Registers a set of capabilities that this resource does not directly provide but to which it contributes.voidregisterMetric(AttributeDefinition definition, OperationStepHandler metricHandler)Records that the given attribute is a metric.voidregisterNotification(NotificationDefinition notification)Record that the given notification can be emitted by this resource.voidregisterNotification(NotificationDefinition notification, boolean inherited)Record that the given notification can be emitted by this resource.voidregisterOperationHandler(OperationDefinition definition, OperationStepHandler handler)Register an operation handler for this resource.voidregisterOperationHandler(OperationDefinition definition, OperationStepHandler handler, boolean inherited)Register an operation handler for this resource.ManagementResourceRegistrationregisterOverrideModel(String name, OverrideDescriptionProvider descriptionProvider)Register a specifically named resource that overrides thiswildcard registrationby adding additional attributes, operations or child types.voidregisterProxyController(PathElement address, ProxyController proxyController)Register a proxy controller.voidregisterReadOnlyAttribute(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.voidregisterReadWriteAttribute(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.voidregisterRequirements(Set<CapabilityReferenceRecorder> requirements)Registers a set of CapabilityReferenceRecorder.ManagementResourceRegistrationregisterSubModel(ResourceDefinition resourceDefinition)Register the existence of an addressable sub-resource of this resource.voidsetRuntimeOnly(boolean runtimeOnly)Sets whether this model node only exists in the runtime and has no representation in the persistent configuration model.voidunregisterAlias(PathElement address)Unregister an aliasvoidunregisterAttribute(String attributeName)Remove that the given attribute if present.voidunregisterNotification(String notificationType)Remove that the given notification can be emitted by this resource.voidunregisterOperationHandler(String operationName)Unregister an operation handler for this resource.voidunregisterOverrideModel(String name)Unregister a specifically named resource that overrides awildcard registrationby adding additional attributes, operations or child types.voidunregisterProxyController(PathElement address)Unregister a proxy controllervoidunregisterSubModel(PathElement address)Unregister the existence of an addressable sub-resource of this resource.
-
-
-
Constructor Detail
-
DelegatingManagementResourceRegistration
public DelegatingManagementResourceRegistration(ManagementResourceRegistration delegate)
Creates a new DelegatingManagementResourceRegistration with a fixed delegate.- Parameters:
delegate- the delegate. Cannot benull
-
DelegatingManagementResourceRegistration
public DelegatingManagementResourceRegistration(DelegatingManagementResourceRegistration.RegistrationDelegateProvider delegateProvider)
Creates a new DelegatingManagementResourceRegistration with a possibly changing delegate.- Parameters:
delegateProvider- provider of the delegate. Cannot benull
-
-
Method Detail
-
getPathAddress
public PathAddress getPathAddress()
Description copied from interface:ImmutableManagementResourceRegistrationGets the address under which we are registered.- Specified by:
getPathAddressin interfaceImmutableManagementResourceRegistration- Returns:
- the address. Will not be
null
-
getProcessType
public ProcessType getProcessType()
Description copied from interface:ImmutableManagementResourceRegistrationGets the type of process in which this management resource type is registered.- Specified by:
getProcessTypein interfaceImmutableManagementResourceRegistration- Returns:
- the process type. Will not return
null
-
getParent
public ImmutableManagementResourceRegistration getParent()
Description copied from interface:ImmutableManagementResourceRegistrationGets the registration for this resource type's parent, if there is one.- Specified by:
getParentin interfaceImmutableManagementResourceRegistration- Returns:
- the parent, or
nullifImmutableManagementResourceRegistration.getPathAddress()returns an address with asizeof0
-
getMaxOccurs
public int getMaxOccurs()
Description copied from interface:ImmutableManagementResourceRegistrationGets 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:
getMaxOccursin interfaceImmutableManagementResourceRegistration- Returns:
- the minimum number of occurrences
-
getMinOccurs
public int getMinOccurs()
Description copied from interface:ImmutableManagementResourceRegistrationGets 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:
getMinOccursin interfaceImmutableManagementResourceRegistration- Returns:
- the minimum number of occurrences
-
getFeature
public String getFeature()
- Specified by:
getFeaturein interfaceImmutableManagementResourceRegistration
-
isFeature
public boolean isFeature()
- Specified by:
isFeaturein interfaceImmutableManagementResourceRegistration
-
isRuntimeOnly
public boolean isRuntimeOnly()
Description copied from interface:ImmutableManagementResourceRegistrationGets whether this model node only exists in the runtime and has no representation in the persistent configuration model.- Specified by:
isRuntimeOnlyin interfaceImmutableManagementResourceRegistration- Returns:
trueif the model node has no representation in the persistent configuration model;falseotherwise
-
isRemote
public boolean isRemote()
Description copied from interface:ImmutableManagementResourceRegistrationGets whether operations against the resource represented by this registration will be proxied to a remote process.- Specified by:
isRemotein interfaceImmutableManagementResourceRegistration- Returns:
trueif this registration represents a remote resource;falseotherwise
-
isAlias
public boolean isAlias()
Description copied from interface:ImmutableManagementResourceRegistrationGets whether this resource registration is an alias to another resource.- Specified by:
isAliasin interfaceImmutableManagementResourceRegistration- Returns:
trueif this registration represents an alias;falseotherwise
-
getOperationEntry
public OperationEntry getOperationEntry(PathAddress address, String operationName)
Description copied from interface:ImmutableManagementResourceRegistrationGet the entry representing an operation registered with the given name at the given address, ornullif none exists.- Specified by:
getOperationEntryin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address, relative to this nodeoperationName- the operation name- Returns:
- the operation entry or
null
-
getOperationHandler
public OperationStepHandler getOperationHandler(PathAddress address, String operationName)
Description copied from interface:ImmutableManagementResourceRegistrationGet the operation handler at the given address, ornullif none exists.- Specified by:
getOperationHandlerin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address, relative to this nodeoperationName- the operation name- Returns:
- the operation handler
-
getOperationDescription
public DescriptionProvider getOperationDescription(PathAddress address, String operationName)
Description copied from interface:ImmutableManagementResourceRegistrationGet the operation description at the given address, ornullif none exists.- Specified by:
getOperationDescriptionin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address, relative to this nodeoperationName- the operation name- Returns:
- the operation description
-
getOperationFlags
public Set<OperationEntry.Flag> getOperationFlags(PathAddress address, String operationName)
Description copied from interface:ImmutableManagementResourceRegistrationGet the special characteristic flags for the operation at the given address, ornullif none exist.- Specified by:
getOperationFlagsin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address, relative to this nodeoperationName- the operation name- Returns:
- the operation entry flags or
null
-
getAttributeNames
public Set<String> getAttributeNames(PathAddress address)
Description copied from interface:ImmutableManagementResourceRegistrationGet the names of the attributes for a node- Specified by:
getAttributeNamesin interfaceImmutableManagementResourceRegistration- 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:ImmutableManagementResourceRegistrationGets the information on how to read from or write to the given attribute.- Specified by:
getAttributeAccessin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address of the resourceattributeName- the name of the attribute- Returns:
- the handling information, or
nullif the attribute or address is unknown
-
getAttributes
public Map<String,AttributeAccess> getAttributes(PathAddress address)
Description copied from interface:ImmutableManagementResourceRegistrationGet the information about all attributes for a node.- Specified by:
getAttributesin interfaceImmutableManagementResourceRegistration- 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:ImmutableManagementResourceRegistrationGet the names of the types of children for a node- Specified by:
getChildNamesin interfaceImmutableManagementResourceRegistration- 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:ImmutableManagementResourceRegistrationGets the set of direct child address elements under the node at the passed in PathAddress- Specified by:
getChildAddressesin interfaceImmutableManagementResourceRegistration- 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:ImmutableManagementResourceRegistrationGet the model description at the given address, ornullif none exists.- Specified by:
getModelDescriptionin interfaceImmutableManagementResourceRegistration- 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:ImmutableManagementResourceRegistrationGet a map of descriptions of all operations available at an address.- Specified by:
getOperationDescriptionsin interfaceImmutableManagementResourceRegistration- Parameters:
address- the addressinherited- true to include inherited operations- Returns:
- the operation map
-
getNotificationDescriptions
public Map<String,NotificationEntry> getNotificationDescriptions(PathAddress address, boolean inherited)
Description copied from interface:ImmutableManagementResourceRegistrationGet a map of descriptions of all notifications emitted by the resources at an address.- Specified by:
getNotificationDescriptionsin interfaceImmutableManagementResourceRegistration- Parameters:
address- the addressinherited- true to include inherited notifications- Returns:
- the notifications map
-
getProxyController
public ProxyController getProxyController(PathAddress address)
Description copied from interface:ImmutableManagementResourceRegistrationIf 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:
getProxyControllerin interfaceImmutableManagementResourceRegistration- Parameters:
address- the address to look for a proxy under- Returns:
- the found proxy controller, or
nullif there is none
-
getProxyControllers
public Set<ProxyController> getProxyControllers(PathAddress address)
Description copied from interface:ImmutableManagementResourceRegistrationFinds all proxy controllers registered at the passed in address, or at lower levels. E.g. if the address passed in isa=band 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:
getProxyControllersin interfaceImmutableManagementResourceRegistration- 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:ManagementResourceRegistrationGet a specifically named resource that overrides thiswildcard registrationby adding additional attributes, operations or child types.- Specified by:
getOverrideModelin interfaceManagementResourceRegistration- Parameters:
name- the specific name of the resource. Cannot benullorPathElement.WILDCARD_VALUE- Returns:
- the resource registration,
nullif there is none
-
getSubModel
public ManagementResourceRegistration getSubModel(PathAddress address)
Description copied from interface:ManagementResourceRegistrationGet 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:
getSubModelin interfaceImmutableManagementResourceRegistration- Specified by:
getSubModelin interfaceManagementResourceRegistration- Parameters:
address- the address, relative to this node- Returns:
- the resource registration,
nullif there is none
-
registerSubModel
public ManagementResourceRegistration registerSubModel(ResourceDefinition resourceDefinition)
Description copied from interface:ManagementResourceRegistrationRegister the existence of an addressable sub-resource of this resource. Before this method returns the providedresourceDefinitionwill be given the opportunity toregister attributes,register operations, andregister notifications- Specified by:
registerSubModelin interfaceManagementResourceRegistration- Parameters:
resourceDefinition- source for descriptive information describing this portion of the model (must not benull)- 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:ManagementResourceRegistrationUnregister the existence of an addressable sub-resource of this resource.- Specified by:
unregisterSubModelin interfaceManagementResourceRegistration- Parameters:
address- the child of this registry that should no longer be available
-
isAllowsOverride
public boolean isAllowsOverride()
Description copied from interface:ManagementResourceRegistrationGets whether this registration will always throw an exception ifManagementResourceRegistration.registerOverrideModel(String, OverrideDescriptionProvider)is invoked. An exception will always be thrown for root resource registrations,non-wildcard registrations, orremote registrations.- Specified by:
isAllowsOverridein interfaceManagementResourceRegistration- Returns:
trueif an exception will not always be thrown;falseif it will
-
setRuntimeOnly
public void setRuntimeOnly(boolean runtimeOnly)
Description copied from interface:ManagementResourceRegistrationSets whether this model node only exists in the runtime and has no representation in the persistent configuration model.- Specified by:
setRuntimeOnlyin interfaceManagementResourceRegistration- Parameters:
runtimeOnly-trueif the model node will have no representation in the persistent configuration model;falseotherwise
-
registerOverrideModel
public ManagementResourceRegistration registerOverrideModel(String name, OverrideDescriptionProvider descriptionProvider)
Description copied from interface:ManagementResourceRegistrationRegister a specifically named resource that overrides thiswildcard registrationby adding additional attributes, operations or child types.- Specified by:
registerOverrideModelin interfaceManagementResourceRegistration- Parameters:
name- the specific name of the resource. Cannot benullorPathElement.WILDCARD_VALUEdescriptionProvider- 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:ManagementResourceRegistrationUnregister a specifically named resource that overrides awildcard registrationby adding additional attributes, operations or child types.- Specified by:
unregisterOverrideModelin interfaceManagementResourceRegistration- Parameters:
name- the specific name of the resource. Cannot benullorPathElement.WILDCARD_VALUE
-
registerOperationHandler
public void registerOperationHandler(OperationDefinition definition, OperationStepHandler handler)
Description copied from interface:ManagementResourceRegistrationRegister an operation handler for this resource.- Specified by:
registerOperationHandlerin interfaceManagementResourceRegistration- Parameters:
definition- the definition of operationhandler- the operation handler
-
registerOperationHandler
public void registerOperationHandler(OperationDefinition definition, OperationStepHandler handler, boolean inherited)
Description copied from interface:ManagementResourceRegistrationRegister an operation handler for this resource.- Specified by:
registerOperationHandlerin interfaceManagementResourceRegistration- Parameters:
definition- the definition of operationhandler- the operation handlerinherited-trueif the operation is inherited to child nodes,falseotherwise
-
unregisterOperationHandler
public void unregisterOperationHandler(String operationName)
Description copied from interface:ManagementResourceRegistrationUnregister an operation handler for this resource.- Specified by:
unregisterOperationHandlerin interfaceManagementResourceRegistration- Parameters:
operationName- the operation name
-
registerReadWriteAttribute
public void registerReadWriteAttribute(AttributeDefinition definition, OperationStepHandler readHandler, OperationStepHandler writeHandler)
Description copied from interface:ManagementResourceRegistrationRecords 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 beAttributeAccess.Storage.CONFIGURATIONunless parameterflagsincludesAttributeAccess.Flag.STORAGE_RUNTIME.- Specified by:
registerReadWriteAttributein interfaceManagementResourceRegistration- Parameters:
definition- the attribute definition. Cannot benullreadHandler- the handler for attribute reads. May benullin which case the default handling is usedwriteHandler- the handler for attribute writes. Cannot benull
-
registerReadOnlyAttribute
public void registerReadOnlyAttribute(AttributeDefinition definition, OperationStepHandler readHandler)
Description copied from interface:ManagementResourceRegistrationRecords 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 beAttributeAccess.Storage.CONFIGURATIONunless parameterflagsincludesAttributeAccess.Flag.STORAGE_RUNTIME.- Specified by:
registerReadOnlyAttributein interfaceManagementResourceRegistration- Parameters:
definition- the attribute definition. Cannot benullreadHandler- the handler for attribute reads. May benullin which case the default handling is used
-
registerMetric
public void registerMetric(AttributeDefinition definition, OperationStepHandler metricHandler)
Description copied from interface:ManagementResourceRegistrationRecords that the given attribute is a metric.- Specified by:
registerMetricin interfaceManagementResourceRegistration- Parameters:
definition- the attribute definition. Cannot benullmetricHandler- the handler for attribute reads. Cannot benull
-
unregisterAttribute
public void unregisterAttribute(String attributeName)
Description copied from interface:ManagementResourceRegistrationRemove that the given attribute if present.- Specified by:
unregisterAttributein interfaceManagementResourceRegistration- Parameters:
attributeName- the name of the attribute. Cannot benull
-
registerNotification
public void registerNotification(NotificationDefinition notification, boolean inherited)
Description copied from interface:ManagementResourceRegistrationRecord that the given notification can be emitted by this resource.- Specified by:
registerNotificationin interfaceManagementResourceRegistration- Parameters:
notification- the definition of the notification. Cannot benullinherited-trueif the notification is inherited to child nodes,falseotherwise
-
registerNotification
public void registerNotification(NotificationDefinition notification)
Description copied from interface:ManagementResourceRegistrationRecord that the given notification can be emitted by this resource. The notification is not inherited by child nodes.- Specified by:
registerNotificationin interfaceManagementResourceRegistration- Parameters:
notification- the definition of the notification. Cannot benull
-
unregisterNotification
public void unregisterNotification(String notificationType)
Description copied from interface:ManagementResourceRegistrationRemove that the given notification can be emitted by this resource.- Specified by:
unregisterNotificationin interfaceManagementResourceRegistration- Parameters:
notificationType- the type of the notification. Cannot benull
-
registerProxyController
public void registerProxyController(PathElement address, ProxyController proxyController)
Description copied from interface:ManagementResourceRegistrationRegister a proxy controller.- Specified by:
registerProxyControllerin interfaceManagementResourceRegistration- Parameters:
address- the child of this registry that should be proxiedproxyController- the proxy controller
-
unregisterProxyController
public void unregisterProxyController(PathElement address)
Description copied from interface:ManagementResourceRegistrationUnregister a proxy controller- Specified by:
unregisterProxyControllerin interfaceManagementResourceRegistration- 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:ManagementResourceRegistrationRegister an alias registration to another part of the model- Specified by:
registerAliasin interfaceManagementResourceRegistration- Parameters:
address- the child of this registry that is an aliasaliasEntry- the target model
-
unregisterAlias
public void unregisterAlias(PathElement address)
Description copied from interface:ManagementResourceRegistrationUnregister an alias- Specified by:
unregisterAliasin interfaceManagementResourceRegistration- Parameters:
address- the child of this registry that is an alias
-
getAccessConstraints
public List<AccessConstraintDefinition> getAccessConstraints()
- Specified by:
getAccessConstraintsin interfaceImmutableManagementResourceRegistration
-
getAliasEntry
public AliasEntry getAliasEntry()
Description copied from interface:ImmutableManagementResourceRegistrationGets the alias entry for this registration if it is an alias- Specified by:
getAliasEntryin interfaceImmutableManagementResourceRegistration- Returns:
- the alias entry if this registration represents an aliased resource;
nullotherwise
-
getOrderedChildTypes
public Set<String> getOrderedChildTypes()
Description copied from interface:ImmutableManagementResourceRegistrationReturn the names of the child types registered to be ordered.- Specified by:
getOrderedChildTypesin interfaceImmutableManagementResourceRegistration- Returns:
- the set of ordered child types, and and empty set if there are none
-
isOrderedChildResource
public boolean isOrderedChildResource()
Description copied from interface:ImmutableManagementResourceRegistrationReturn @code true} if a child resource registration was registered usingManagementResourceRegistration.registerSubModel(ResourceDefinition), andfalseotherwise- Specified by:
isOrderedChildResourcein interfaceImmutableManagementResourceRegistration- Returns:
- whether this is an ordered child or not
-
registerCapability
public void registerCapability(RuntimeCapability capability)
Description copied from interface:ManagementResourceRegistrationRegisters passed capability on resource- Specified by:
registerCapabilityin interfaceManagementResourceRegistration- Parameters:
capability- a capability to register
-
registerIncorporatingCapabilities
public void registerIncorporatingCapabilities(Set<RuntimeCapability> capabilities)
Description copied from interface:ManagementResourceRegistrationRegisters a set of capabilities that this resource does not directly provide but to which it contributes. This will only include capabilities for which this resource does not control theregistration of the capability. Any capabilities registered by this resource will instead be included in the return value forImmutableManagementResourceRegistration.getCapabilities().Use of this method is only necessary if the caller wishes to specifically record capability incorporation, instead of relying on the default resolution mechanism detailed in
ImmutableManagementResourceRegistration.getIncorporatingCapabilities(), or if it wishes disable the default resolution mechanism and specifically declare that this resource does not contribute to parent capabilities. It does the latter by passing an empty set as thecapabilitiesparameter. Passing an empty set is not necessary if this resource itself directlyprovides a capability, as it is the contract ofImmutableManagementResourceRegistration.getIncorporatingCapabilities()that in that case it must return an empty set.- Specified by:
registerIncorporatingCapabilitiesin interfaceManagementResourceRegistration- Parameters:
capabilities- set of capabilities, ornullif 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
-
registerRequirements
public void registerRequirements(Set<CapabilityReferenceRecorder> requirements)
Description copied from interface:ManagementResourceRegistrationRegisters a set of CapabilityReferenceRecorder. Each recorder is a link between acapability requirement and the resource capability requiring it.- Specified by:
registerRequirementsin interfaceManagementResourceRegistration- Parameters:
requirements- a set of CapabilityReferenceRecorder.
-
getCapabilities
public Set<RuntimeCapability> getCapabilities()
Description copied from interface:ImmutableManagementResourceRegistrationReturns 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:
getCapabilitiesin interfaceImmutableManagementResourceRegistration- Returns:
- Set of capabilities if any registered otherwise an empty set
- See Also:
ImmutableManagementResourceRegistration.getIncorporatingCapabilities()
-
getIncorporatingCapabilities
public Set<RuntimeCapability> getIncorporatingCapabilities()
Description copied from interface:ImmutableManagementResourceRegistrationReturns 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 forImmutableManagementResourceRegistration.getCapabilities().Often, this method will return
null, which has a special meaning. Anullvalue 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:- The ancestor has registered a capability; i.e. once a capability is identified, higher levels are not searched
- 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
- The ancestor is a root resource. Child resources do not contribute to root capabilities unless they specifically declare they do so
- 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 - 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-
nullvalue 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 returnnullfrom 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
RuntimeCapabilityitself. A typical "contributing" resource would be one that represents a chunk of configuration directly used by the parent resource's capability.- Specified by:
getIncorporatingCapabilitiesin interfaceImmutableManagementResourceRegistration- Returns:
- set of capabilities, or
nullif 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 returnnullifImmutableManagementResourceRegistration.getCapabilities()returns a non-empty set. - See Also:
ImmutableManagementResourceRegistration.getCapabilities()
-
getRequirements
public Set<CapabilityReferenceRecorder> getRequirements()
Description copied from interface:ImmutableManagementResourceRegistrationReturns all capability reference recorders provided by this resource.- Specified by:
getRequirementsin interfaceImmutableManagementResourceRegistration- Returns:
- Set of CapabilityReferenceRecorder if any registered otherwise an empty set.
-
registerAdditionalRuntimePackages
public void registerAdditionalRuntimePackages(RuntimePackageDependency... pkgs)
Description copied from interface:ManagementResourceRegistrationRegisterRuntimePackageDependencyadditional packages.- Specified by:
registerAdditionalRuntimePackagesin interfaceManagementResourceRegistration- Parameters:
pkgs- The packages.
-
getAdditionalRuntimePackages
public Set<RuntimePackageDependency> getAdditionalRuntimePackages()
Description copied from interface:ImmutableManagementResourceRegistrationReturns additional packages provided by this resource.- Specified by:
getAdditionalRuntimePackagesin interfaceImmutableManagementResourceRegistration- Returns:
- Set of
RuntimePackageDependencyif any registered otherwise an empty set.
-
-