Package org.jboss.as.controller

Interface ResourceDefinition

    • Method Detail

      • getPathElement

        PathElement getPathElement()
        Gets the path element that describes how to navigate to this resource from its parent resource, or null if this is a definition of a root resource.
        Returns:
        the path element, or null if this is a definition of a root resource.

      • registerAdditionalRuntimePackages

        default void registerAdditionalRuntimePackages​(ManagementResourceRegistration resourceRegistration)
        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.
        Parameters:
        resourceRegistration - a ManagementResourceRegistration created from this definition

      • getAccessConstraints

        List<AccessConstraintDefinition> getAccessConstraints()
        Get the definition of any access constraints associated with the resource.
        Returns:
        the access constraints or an empty list; will not return null.

      • isRuntime

        boolean isRuntime()
        Returns:
        true if resource is runtime
        Since:
        WildFly Core 1.0, WildFly 9.0

      • isOrderedChild

        boolean isOrderedChild()
        Whether this is an ordered child or not
        Returns:
        true if this child is ordered within the parent, false otherwise

      • getMaxOccurs

        default int getMaxOccurs()
        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.)
        Returns:
        the minimum number of occurrences

      • getMinOccurs

        default int getMinOccurs()
        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.)
        Returns:
        the minimum number of occurrences

      • isFeature

        default boolean isFeature()