Package org.glassfish.internal.deployment

Interface ExtendedDeploymentContext

All Superinterfaces:
org.glassfish.api.deployment.ApplicationContext, org.glassfish.api.deployment.DeploymentContext, org.glassfish.api.ExecutionContext
public interface ExtendedDeploymentContext extends org.glassfish.api.deployment.DeploymentContext
semi-private interface to the deployment context
Author:
Jerome Dochez

  • Field Details

  • Method Details

    • setPhase

      void setPhase(ExtendedDeploymentContext.Phase newPhase)
      Sets the phase of the deployment activity.
      Parameters:
      newPhase -

    • getPhase

      ExtendedDeploymentContext.Phase getPhase()

    • getTransformers

      List<ClassFileTransformer> getTransformers()
      Returns the list of transformers registered to this context.
      Returns:
      the transformers list

    • createDeploymentClassLoader

      void createDeploymentClassLoader(ClassLoaderHierarchy clh, org.glassfish.api.deployment.archive.ArchiveHandler handler) throws URISyntaxException, MalformedURLException
      Create the deployment class loader. It will be used for sniffer retrieval, metadata parsing and deployer prepare.
      Parameters:
      clh - the hierarchy of class loader for the parent
      handler - the archive handler for the source archive
      Throws:
      URISyntaxException
      MalformedURLException

    • createApplicationClassLoader

      void createApplicationClassLoader(ClassLoaderHierarchy clh, org.glassfish.api.deployment.archive.ArchiveHandler handler) throws URISyntaxException, MalformedURLException
      Create the final class loader. It will be used to load and start application.
      Parameters:
      clh - the hierarchy of class loader for the parent
      handler - the archive handler for the source archive
      Throws:
      URISyntaxException
      MalformedURLException

    • clean

      void clean()

    • setArchiveHandler

      void setArchiveHandler(org.glassfish.api.deployment.archive.ArchiveHandler archiveHandler)
      Sets the archive handler that's associated with this context
      Parameters:
      archiveHandler -

    • setSource

      void setSource(org.glassfish.api.deployment.archive.ReadableArchive source)
      Sets the source archive
      Parameters:
      props -

    • setModulePropsMap

      void setModulePropsMap(Map<String,Properties> modulePropsMap)
      Sets the module properties for modules
      Parameters:
      modulePropsMap -

    • getModuleDeploymentContexts

      Map<String,ExtendedDeploymentContext> getModuleDeploymentContexts()
      Gets the deployment context for modules
      Returns:
      a map containing module deployment contexts

    • setClassLoader

      void setClassLoader(ClassLoader cloader)
      Sets the classloader
      Parameters:
      cloader -

    • setParentContext

      void setParentContext(ExtendedDeploymentContext parentContext)
      Sets the parent context
      Parameters:
      parentContext -

    • getModuleUri

      String getModuleUri()
      Gets the module uri for this module context
      Returns:
      the module uri

    • setModuleUri

      void setModuleUri(String moduleUri)
      Sets the module uri for this module context
      Parameters:
      moduleUri -

    • getParentContext

      ExtendedDeploymentContext getParentContext()
      Gets the parent context for this context
      Returns:
      the parent context

    • getAppInternalDir

      File getAppInternalDir()
      Returns the internal directory for the application (used for holding the uploaded archive, for example).
      Returns:
      location of the internal directory for the application

    • getAppAltDDDir

      File getAppAltDDDir()
      Returns the alternate deployment descriptor directory for the application (used for holding the external alternate deployment descriptors).
      Returns:
      location of the alternate deployment descriptor directory for the application

    • getTenant

      String getTenant()
      Returns the tenant, if one is valid for this DeploymentContext.
      Returns:
      tenant name if applicable, null if no tenant is set for this DC

    • setTenant

      void setTenant(String tenant, String appName)
      Sets the tenant to which this deployment context applies. Also initializes the tenant directory.
      Parameters:
      tenantName - the name of the tenant
      appName - the name of the application

    • getTenantDir

      File getTenantDir()
      Returns the directory containing the expanded tenant customization archive, if this DC is for a tenant and if a customization archive was specified when the tenant was provisioned.
      Returns:
      directory containing the expanded customization archive; null if none

    • postDeployClean

      void postDeployClean(boolean isFinalClean)
      Performs any clean-up of the deployment context after deployment has finished.

      This method can be invoked either with "true", meaning that this is the final clean-up for the DC, or with "false," meaning that the DC implementation should be selective. (Some data is used, for instance, in the DeployCommand logic after ApplicationLifeCycle.deploy has completed.)

      Parameters:
      isFinalClean - whether this clean is the final clean or a selective one.

    • prepareScratchDirs

      void prepareScratchDirs() throws IOException
      Prepare the scratch directories, creating the directories if they do not exist
      Throws:
      IOException