Class AppClientDeployerHelper

    • Method Detail

      • facadeServerURI

        public abstract URI facadeServerURI​(DeploymentContext dc)
        Returns the URI to the server's copy of the facade JAR file.
        Parameters:
        dc - the deployment context for the current deployment
        Returns:
      • facadeUserURI

        public abstract URI facadeUserURI​(DeploymentContext dc)
        Returns the URI for the facade JAR, relative to the download directory to which the user will fetch the relevant JARs (either as part of "deploy --retrieve" or "get-client-stubs."
        Parameters:
        dc - the deployment context for the current deployment
        Returns:
      • groupFacadeUserURI

        public abstract URI groupFacadeUserURI​(DeploymentContext dc)
        Returns the URI for the group facade JAR, relative to the download directory to which the user will fetch the relevant JARs (either as part of "deploy --retrieve" or "get-client-stubs."
        Parameters:
        dc - the deployment context for the current deployment
        Returns:
      • facadeFileNameAndType

        protected abstract String facadeFileNameAndType​(DeploymentContext dc)
        Returns the file name (and type) for the facade, excluding any directory information.
        Parameters:
        dc - the deployment context for the current deployment
        Returns:
      • appClientUserURI

        public abstract URI appClientUserURI​(DeploymentContext dc)
        Returns the URI to the developer's original app client JAR within the download directory the user specifies in "deploy --retrieve" or "get-client-stubs."
        Parameters:
        dc -
        Returns:
      • appClientUserURIForFacade

        public abstract URI appClientUserURIForFacade​(DeploymentContext dc)
        Returns the URI to be used for the GlassFish-AppClient manifest entry in the facade.
        Parameters:
        dc -
        Returns:
      • appClientServerURI

        public abstract URI appClientServerURI​(DeploymentContext dc)
        Returns the URI to the server's copy of the developer's original app client JAR.
        Parameters:
        dc -
        Returns:
      • appClientServerOriginalAnchor

        public abstract URI appClientServerOriginalAnchor​(DeploymentContext dc)
        Returns the URI on the server to the original location of the app client.

        This is distinct from the appClientServerURI which could be in the generated directory (in the case of a directory deployment, for example). In some cases we need the original location of the app client on the server (for example, to resolve relative references from the app client JAR's manifest Class-Path).

        Parameters:
        dc -
        Returns:
      • appClientURIWithinApp

        public abstract URI appClientURIWithinApp​(DeploymentContext dc)
        Returns the URI within the enclosing app of the app client JAR. Stand-alone app clients are considered to lie within an "implied" containing app; the URI for such app clients is just the file name and type. The URI for nested app clients within an EAR is the module URI to the app client.
        Parameters:
        dc -
        Returns:
      • pathToAppclientWithinApp

        public abstract String pathToAppclientWithinApp​(DeploymentContext dc)
        Returns the relative path to the app client within the enclosing app. The result will be an empty string for a stand-alone app clients because it has no such path, in reality. The result will be the relative URI within the EAR for a nested app client.
        Parameters:
        dc -
        Returns:
      • URIWithinAppDir

        public abstract URI URIWithinAppDir​(DeploymentContext dc,
                                            URI absoluteURI)
        Returns a relative URI within the app directory for the specified absolute URI.
        Parameters:
        dc -
        absoluteURI -
        Returns:
      • facadeClassPath

        protected abstract String facadeClassPath()
        Returns the class path to be stored in the manifest for the generated facade JAR file.
        Returns:
      • PUScanTargets

        protected abstract String PUScanTargets()
      • appName

        public String appName()
      • clientName

        public String clientName()
      • fixedContentWithinEAR

        public abstract FixedContent fixedContentWithinEAR​(String uriString)
        Returns a FixedContent object for the file, within the EAR, at the specified relative location.
        Parameters:
        uriString - relative path within the EAR
        Returns:
        FixedContent object for the file
      • rootForSignedFilesInApp

        public abstract File rootForSignedFilesInApp()
        Returns the root directory for signed files in the applications.
        Returns:
        File object for the signed JAR root directory
      • relativeURIToGroupFacade

        protected URI relativeURIToGroupFacade()
      • addClientPolicyFiles

        protected void addClientPolicyFiles​(OutputJarArchive clientFacadeArchive)
                                     throws IOException
        Adds the client policy files to the top-level generated JAR.

        For a stand-alone client (not in an EAR) this implementation adds the policy files to the generated app client facade JAR.

        Parameters:
        clientFacadeArchive - the generated app client facade JAR
        Throws:
        IOException