Package org.jboss.as.controller
Class ProvidedResourceDefinition
java.lang.Object
org.jboss.as.controller.ProvidedResourceDefinition
- All Implemented Interfaces:
Feature,ResourceDefinition,ResourceRegistration
- Direct Known Subclasses:
DelegatingResourceDefinition
Generalized
ResourceDefinition decorator.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jboss.as.controller.ResourceDefinition
ResourceDefinition.AbstractConfigurator<C extends ResourceDefinition.Configurator<C>>, ResourceDefinition.Builder, ResourceDefinition.Configurator<C extends ResourceDefinition.Configurator<C>>, ResourceDefinition.MinimalBuilder, ResourceDefinition.MinimalResourceDefinitionNested classes/interfaces inherited from interface org.jboss.as.controller.ResourceRegistration
ResourceRegistration.DefaultResourceRegistration -
Constructor Summary
ConstructorsConstructorDescriptionProvidedResourceDefinition(Supplier<ResourceDefinition> provider) ProvidedResourceDefinition(ResourceDefinition definition) -
Method Summary
Modifier and TypeMethodDescriptionGet the definition of any access constraints associated with the resource.Gets aDescriptionProviderfor the given resource.intGets the maximum number of times a resource of the type described by this definition can occur under its parent resource (or, for a root resource, the minimum number of times it can occur at all.)intGets the minimum number of times a resource of the type described by this definition can occur under its parent resource (or, for a root resource, the number of times it can occur at all.)Returns the path element under which this resource is registered with its parent resource, ornullif this is the root resource.Returns the stability level of this feature.booleanbooleanWhether this is an ordered child or notbooleanvoidRegister "additional" Galleon packages that must be installed in order for this Resource to function.voidregisterAttributes(ManagementResourceRegistration registration) Register operations associated with this resource.voidregisterCapabilities(ManagementResourceRegistration registration) Register capabilities associated with this resource.voidregisterChildren(ManagementResourceRegistration registration) Register child resources associated with this resource.voidregisterNotifications(ManagementResourceRegistration registration) Register notifications associated with this resource.voidregisterOperations(ManagementResourceRegistration registration) Register operations associated with this resource.
-
Constructor Details
-
ProvidedResourceDefinition
-
ProvidedResourceDefinition
-
-
Method Details
-
getPathElement
Description copied from interface:ResourceRegistrationReturns the path element under which this resource is registered with its parent resource, ornullif this is the root resource.- Specified by:
getPathElementin interfaceResourceRegistration- Returns:
- the path element, or
nullif this is the root resource.
-
getDescriptionProvider
public DescriptionProvider getDescriptionProvider(ImmutableManagementResourceRegistration registration) Description copied from interface:ResourceDefinitionGets aDescriptionProviderfor the given resource.- Specified by:
getDescriptionProviderin interfaceResourceDefinition- Parameters:
registration- the resource. Cannot benull- Returns:
- the description provider. Will not be
null
-
registerOperations
Description copied from interface:ResourceDefinitionRegister operations associated with this resource.- Specified by:
registerOperationsin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
registerAttributes
Description copied from interface:ResourceDefinitionRegister operations associated with this resource.- Specified by:
registerAttributesin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
registerNotifications
Description copied from interface:ResourceDefinitionRegister notifications associated with this resource.- Specified by:
registerNotificationsin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
registerChildren
Description copied from interface:ResourceDefinitionRegister child resources associated with this resource.- Specified by:
registerChildrenin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
registerCapabilities
Description copied from interface:ResourceDefinitionRegister capabilities associated with this resource.- Specified by:
registerCapabilitiesin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
registerAdditionalRuntimePackages
Description copied from interface:ResourceDefinitionRegister "additional" Galleon packages that must be installed in order for this Resource to function. NB: the packages need to be visible from the feature pack that contains the ResourceDefinition. It can't be any package from any feature pack. The purpose of providing this information is to make it available to the Galleon tooling that produces Galleon feature-specs, in order to allow the tooling to include the package information in the relevant spec.A package is "additional" if it is not one of the "standard" packages that must be installed. The names of "standard" packages should not be registered. The "standard" packages are:
- The root package for the process type; i.e. the package that provides the main module whose name is passed to JBoss Modules when the process is launched.
- The package that installs the module that provides the extension in which the resource is defined.
- Any package that is non-optionally directly or transitively required by one of the other types of standard packages.
-
Packages that install required modules injected into Deployment Unit can be registered as
required
RuntimePackageDependency. -
Packages that install optional modules injected into Deployment Unit can be registered as
optional
RuntimePackageDependency. -
Packages that install modules that are only required if the resource associated to this
definition is instantiated are to be registered as required
RuntimePackageDependency. -
Packages that install modules that are only required by this feature in order to interact with other features
are to be registered as passive
RuntimePackageDependency. A passive dependency is provisioned only if its own required dependencies are present.
- Specified by:
registerAdditionalRuntimePackagesin interfaceResourceDefinition- Parameters:
registration- aManagementResourceRegistrationcreated from this definition
-
isFeature
public boolean isFeature()- Specified by:
isFeaturein interfaceResourceDefinition
-
isOrderedChild
public boolean isOrderedChild()Description copied from interface:ResourceDefinitionWhether this is an ordered child or not- Specified by:
isOrderedChildin interfaceResourceDefinition- Returns:
trueif this child is ordered within the parent, false otherwise
-
isRuntime
public boolean isRuntime()- Specified by:
isRuntimein interfaceResourceDefinition- Returns:
- true if resource is runtime
-
getAccessConstraints
Description copied from interface:ResourceDefinitionGet the definition of any access constraints associated with the resource.- Specified by:
getAccessConstraintsin interfaceResourceDefinition- Returns:
- the access constraints or an empty list; will not return
null.
-
getMaxOccurs
public int getMaxOccurs()Description copied from interface:ResourceDefinitionGets the maximum number of times a resource of the type described by this definition can occur under its parent resource (or, for a root resource, the minimum number of times it can occur at all.)- Specified by:
getMaxOccursin interfaceResourceDefinition- Returns:
- the minimum number of occurrences
-
getMinOccurs
public int getMinOccurs()Description copied from interface:ResourceDefinitionGets the minimum number of times a resource of the type described by this definition can occur under its parent resource (or, for a root resource, the number of times it can occur at all.)- Specified by:
getMinOccursin interfaceResourceDefinition- Returns:
- the minimum number of occurrences
-
getStability
Description copied from interface:FeatureReturns the stability level of this feature.- Specified by:
getStabilityin interfaceFeature- Returns:
- a stability level
-