Package org.glassfish.deployment.common

Class DeploymentUtils

  • public class DeploymentUtils
extends Object
    Utility methods for deployment.

    • Constructor Detail

      • DeploymentUtils

        public DeploymentUtils()

    • Method Detail

      • isDASTarget

        public static boolean isDASTarget​(String targetName)

      • isDomainTarget

        public static boolean isDomainTarget​(String targetName)

      • checksum

        public static long checksum​(File directory)
        Computes the checksum of the URIs of files contained in a directory.
        Parameters:
        directory - the directory for which to compute a checksum
        Returns:
        checksum calculated from URIs of files in the directory

      • downloadableArtifacts

        public static Artifacts downloadableArtifacts​(org.glassfish.api.deployment.DeploymentContext dc)
        Returns the downloadable artifacts object from the specified deployment context, creating it there if it does not already exist.
        Parameters:
        dc - the deployment context from which to fetch the downloadable Artifacts object
        Returns:

      • downloadableArtifacts

        public static Artifacts downloadableArtifacts​(com.sun.enterprise.config.serverbeans.Application app)
        Returns the downloadable artifacts object derived from the properties saved with the specified Application
        Parameters:
        app - the Application config object with (possibly) properties describing downloadable artifacts
        Returns:

      • generatedArtifacts

        public static Artifacts generatedArtifacts​(org.glassfish.api.deployment.DeploymentContext dc)
        Returns the generated artifacts object from the specified deployment context, creating it there if it does not already exist.
        Parameters:
        app -
        Returns:

      • generatedArtifacts

        public static Artifacts generatedArtifacts​(com.sun.enterprise.config.serverbeans.Application app)
        Returns the generated artifacts object derived from the properties saved with the specified Application
        Parameters:
        app - the Application config object with (possibly) properties describing generated artifacts
        Returns:

      • isArchiveOfType

        public static boolean isArchiveOfType​(org.glassfish.api.deployment.archive.ReadableArchive archive,
                                      org.glassfish.api.deployment.archive.ArchiveType archiveType,
                                      org.glassfish.api.deployment.DeploymentContext context,
                                      org.glassfish.hk2.api.ServiceLocator locator)

      • isArchiveOfType

        public static boolean isArchiveOfType​(org.glassfish.api.deployment.archive.ReadableArchive archive,
                                      org.glassfish.api.deployment.archive.ArchiveType archiveType,
                                      org.glassfish.hk2.api.ServiceLocator locator)

      • getDefaultEEName

        public static String getDefaultEEName​(String pathName)
        Parameters:
        pathName -
        Returns:
        the default value of the EE name. The default name is the pathname with any filename extension (.jar, .war, .rar) removed, but with any directory names included.

      • getRelativeEmbeddedModulePath

        public static String getRelativeEmbeddedModulePath​(String appRootPath,
                                                   String moduleUri)
        This method returns the relative file path of an embedded module to the application root. For example, if the module is expanded/located at $domain_dir/applications/j2ee-apps/foo/fooEJB_jar, this method will return fooEJB_jar
        Parameters:
        appRootPath - The path of the application root which contains the module e.g. $domain_dir/applications/j2ee-apps/foo
        moduleUri - The module uri e.g. fooEJB.jar
        Returns:
        The relative file path of the module to the application root

      • getEmbeddedModulePath

        public static String getEmbeddedModulePath​(String appRootPath,
                                           String moduleUri)
        This method returns the file path of an embedded module. For example, if the module is expanded/located at $domain_dir/applications/j2ee-apps/foo/fooEJB_jar, this method will return $domain_dir/applications/j2ee-apps/foo/fooEJB_jar
        Parameters:
        appRootPath - The path of the application root which contains the module e.g. $domain_dir/applications/j2ee-apps/foo
        moduleUri - The module uri e.g. fooEJB.jar
        Returns:
        The file path of the module

      • useV2Compatibility

        public static boolean useV2Compatibility​(org.glassfish.api.deployment.DeploymentContext context)

      • validateApplicationName

        public static void validateApplicationName​(String name)

      • expand

        public static void expand​(org.glassfish.api.deployment.archive.ReadableArchive source,
                          org.glassfish.api.deployment.archive.WritableArchive target)
                   throws IOException
        Expand an archive to a directory
        Parameters:
        source - of the expanding
        target - of the expanding
        Throws:
        IOException - when the archive is corrupted

      • getInternalNameForTenant

        public static String getInternalNameForTenant​(String appname,
                                              String tenantname)

      • propertiesValue

        public static String propertiesValue​(Properties props,
                                     char sep)

      • getManifestLibraries

        public static List<URL> getManifestLibraries​(org.glassfish.api.deployment.DeploymentContext context)
                                      throws IOException
        Throws:
        IOException

      • getManifestLibraries

        public static List<URL> getManifestLibraries​(org.glassfish.api.deployment.DeploymentContext context,
                                             Manifest manifest)
                                      throws IOException
        Throws:
        IOException

      • getManifestLibraries

        public static List<URL> getManifestLibraries​(org.glassfish.api.deployment.archive.ReadableArchive archive)
                                      throws IOException
        Throws:
        IOException

      • getExternalLibraries

        public static List<URI> getExternalLibraries​(org.glassfish.api.deployment.archive.ReadableArchive archive)

      • openAsFileArchive

        public static FileArchive openAsFileArchive​(File dir,
                                            ArchiveFactory archiveFactory)
                                     throws IOException
        Opens the specified file as an archive, using the provided archive factory.
        Parameters:
        dir - directory to be opened as an archive
        archiveFactory - ArchiveFactory to use to create the archive object
        Returns:
        FileArchive opened for the directory
        Throws:
        IOException

      • getVirtualServers

        public static String getVirtualServers​(String target,
                                       org.glassfish.api.admin.ServerEnvironment env,
                                       com.sun.enterprise.config.serverbeans.Domain domain)