Package org.jboss.as.controller

Class ResourceDefinition.MinimalResourceDefinition

java.lang.Object
org.jboss.as.controller.ResourceDefinition.MinimalResourceDefinition
All Implemented Interfaces:
Feature, ResourceDefinition, ResourceRegistration
Direct Known Subclasses:
SimpleResourceDefinition
Enclosing interface:
ResourceDefinition
public static class ResourceDefinition.MinimalResourceDefinition extends Object implements ResourceDefinition
A minimal ResourceDefinition implementation whose internal registration will be performed separately.

  • Method Details

    • getPathElement

      public PathElement getPathElement()
      Description copied from interface: ResourceRegistration
      Returns the path element under which this resource is registered with its parent resource, or null if this is the root resource.
      Specified by:
      getPathElement in interface ResourceRegistration
      Returns:
      the path element, or null if this is the root resource.

    • getStability

      public Stability getStability()
      Description copied from interface: Feature
      Returns the stability level of this feature.
      Specified by:
      getStability in interface Feature
      Returns:
      a stability level

    • getDescriptionProvider

      public DescriptionProvider getDescriptionProvider(ImmutableManagementResourceRegistration registration)
      Description copied from interface: ResourceDefinition
      Gets a DescriptionProvider for the given resource.
      Specified by:
      getDescriptionProvider in interface ResourceDefinition
      Parameters:
      registration - the resource. Cannot be null
      Returns:
      the description provider. Will not be null

    • getMinOccurs

      public int getMinOccurs()
      Description copied from interface: ResourceDefinition
      Gets 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:
      getMinOccurs in interface ResourceDefinition
      Returns:
      the minimum number of occurrences

    • getMaxOccurs

      public int getMaxOccurs()
      Description copied from interface: ResourceDefinition
      Gets 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:
      getMaxOccurs in interface ResourceDefinition
      Returns:
      the minimum number of occurrences

    • getAccessConstraints

      public List<AccessConstraintDefinition> getAccessConstraints()
      Description copied from interface: ResourceDefinition
      Get the definition of any access constraints associated with the resource.
      Specified by:
      getAccessConstraints in interface ResourceDefinition
      Returns:
      the access constraints or an empty list; will not return null.

    • isRuntime

      public boolean isRuntime()
      Specified by:
      isRuntime in interface ResourceDefinition
      Returns:
      true if resource is runtime

    • isOrderedChild

      public boolean isOrderedChild()
      Description copied from interface: ResourceDefinition
      Whether this is an ordered child or not
      Specified by:
      isOrderedChild in interface ResourceDefinition
      Returns:
      true if this child is ordered within the parent, false otherwise

    • isFeature

      public boolean isFeature()
      Specified by:
      isFeature in interface ResourceDefinition

    • registerOperations

      public void registerOperations(ManagementResourceRegistration resourceRegistration)
      Description copied from interface: ResourceDefinition
      Register operations associated with this resource.
      Specified by:
      registerOperations in interface ResourceDefinition
      Parameters:
      resourceRegistration - a ManagementResourceRegistration created from this definition

    • registerAttributes

      public void registerAttributes(ManagementResourceRegistration resourceRegistration)
      Description copied from interface: ResourceDefinition
      Register operations associated with this resource.
      Specified by:
      registerAttributes in interface ResourceDefinition
      Parameters:
      resourceRegistration - a ManagementResourceRegistration created from this definition

    • registerNotifications

      public void registerNotifications(ManagementResourceRegistration resourceRegistration)
      Description copied from interface: ResourceDefinition
      Register notifications associated with this resource.
      Specified by:
      registerNotifications in interface ResourceDefinition
      Parameters:
      resourceRegistration - a ManagementResourceRegistration created from this definition

    • registerChildren

      public void registerChildren(ManagementResourceRegistration resourceRegistration)
      Description copied from interface: ResourceDefinition
      Register child resources associated with this resource.
      Specified by:
      registerChildren in interface ResourceDefinition
      Parameters:
      resourceRegistration - a ManagementResourceRegistration created from this definition

    • registerAdditionalRuntimePackages

      public void registerAdditionalRuntimePackages(ManagementResourceRegistration registration)
      Description copied from interface: ResourceDefinition
      Register "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:

      1. 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.
      2. The package that installs the module that provides the extension in which the resource is defined.
      3. Any package that is non-optionally directly or transitively required by one of the other types of standard packages.
      Additional packages fall into in the following categories:
      1. Packages that install required modules injected into Deployment Unit can be registered as required RuntimePackageDependency.
      2. Packages that install optional modules injected into Deployment Unit can be registered as optional RuntimePackageDependency.
      3. Packages that install modules that are only required if the resource associated to this definition is instantiated are to be registered as required RuntimePackageDependency.
      4. 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:
      registerAdditionalRuntimePackages in interface ResourceDefinition
      Parameters:
      registration - a ManagementResourceRegistration created from this definition