Package org.jboss.as.patching.generator

Interface DistributionStructure

  • public interface DistributionStructure
    Encapsulates rules about the structure of a given standard unzipped distribution of the application server.
    Author:
    Brian Stansberry (c) 2012 Red Hat Inc.

    • Method Detail

      • isIgnored

        boolean isIgnored​(org.jboss.as.patching.generator.DistributionContentItem item)
        See if this content path is ignored.
        Parameters:
        item - the content item
        Returns:
        true if this path should be ignored, false otherwise

      • isModuleLookupPath

        boolean isModuleLookupPath​(org.jboss.as.patching.generator.DistributionContentItem item)
        Check if this path is a module root.
        Parameters:
        item - the content item
        Returns:
        true if this path should be treated as module root

      • isBundleLookupPath

        boolean isBundleLookupPath​(org.jboss.as.patching.generator.DistributionContentItem item)
        Check if this path is a bundle root.
        Parameters:
        item - the content item
        Returns:
        true if this path should be treated as bundle root

      • registerStandardModuleSearchPath

        void registerStandardModuleSearchPath​(String name,
                                      String standardPath)
        Register a module search path.
        Parameters:
        name - logical name for the path
        standardPath - the path

      • excludeDefaultModuleRoot

        void excludeDefaultModuleRoot()
        Configures this structure to no include the default module search path (modules/) as a valid path.

      • registerStandardBundleSearchPath

        void registerStandardBundleSearchPath​(String name,
                                      String standardPath)
        Register a bundle search path.
        Parameters:
        name - logical name for the path
        standardPath - the path

      • excludeDefaultBundleRoot

        void excludeDefaultBundleRoot()
        Configures this structure to no include the default bundle search path (bundles/) as a valid path.

      • registerIgnoredPath

        void registerIgnoredPath​(String path)
        Register a path that should be ignored when analyzing the structure for differences.
        Parameters:
        path - the path

      • isCompatibleWith

        boolean isCompatibleWith​(DistributionStructure other)
        Gets whether this DistributionStructure is compatible with another distribution structure. Compatible structures will, immediately after construction, have the same default bundle and module paths, the same default ignored paths, and the same rules for determining the types of content items.
        Parameters:
        other - the other structure
        Returns:
        true if the structures are compatible, false otherwise