org.glassfish.deployment.common

Class DeploymentContextImpl

java.lang.Object

org.glassfish.deployment.common.DeploymentContextImpl

All Implemented Interfaces:

ApplicationContext, DeploymentContext, ExecutionContext, org.glassfish.hk2.api.PreDestroy, ExtendedDeploymentContext

public class DeploymentContextImpl
extends Object
implements ExtendedDeploymentContext, org.glassfish.hk2.api.PreDestroy

Author:

dochez

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.internal.deployment.ExtendedDeploymentContext

ExtendedDeploymentContext.Phase

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	deplLogger

Fields inherited from interface org.glassfish.internal.deployment.ExtendedDeploymentContext

IS_TEMP_CLASSLOADER, TRACKER

Constructor Summary

Constructors

Constructor and Description
DeploymentContextImpl(ActionReport actionReport, Logger logger, ReadableArchive source, OpsParams params, ServerEnvironment env)
DeploymentContextImpl(ActionReport actionReport, ReadableArchive source, OpsParams params, ServerEnvironment env)
DeploymentContextImpl(Deployment.DeploymentContextBuilder builder, ServerEnvironment env) Creates a new instance of DeploymentContext

Method Summary

Modifier and Type	Method and Description
void	addModuleMetaData(Object metaData) Stores a descriptor for the module in the context so other deployer's can have access to it.
void	addTransformer(ClassFileTransformer transformer) Add a new ClassFileTransformer to the context
void	addTransientAppMetaData(String metaDataKey, Object metaData) Stores application level metadata in the context so other deployer's can have access to it.
void	clean()
void	createApplicationClassLoader(ClassLoaderHierarchy clh, ArchiveHandler handler) Create the final class loader.
void	createDeploymentClassLoader(ClassLoaderHierarchy clh, ArchiveHandler handler) Create the deployment class loader.
ActionReport	getActionReport() Gets the action report for this context
File	getAppAltDDDir() Returns the alternate deployment descriptor directory for the application (used for holding the external alternate deployment descriptors).
File	getAppInternalDir() Returns the internal directory for the application (used for holding the uploaded archive, for example).
List<URI>	getAppLibs() gets the app-libs specified for this archive This list includes --libraries as well EXTENSION_LIST specified in the manifest entries
Properties	getAppProps() Returns the application level properties that will be persisted as a key value pair at then end of deployment.
ArchiveHandler	getArchiveHandler() Returns the archive handler that's associated with this context
ClassLoader	getClassLoader() Returns the class loader associated to this deployment request.
ClassLoader	getClassLoader(boolean sharable)
<U extends OpsParams> U	getCommandParameters(Class<U> commandParametersType) Returns the DeployCommand parameters
ClassLoader	getFinalClassLoader() Returns the class loader associated to this deployment request.
Logger	getLogger() Returns the logger services implementation should use to log useful information about their execution.
Map<String,ArchiveHandler>	getModuleArchiveHandlers() Gets the archive handlers for modules
Map<String,ExtendedDeploymentContext>	getModuleDeploymentContexts() Gets the deployment context for modules
Collection<Object>	getModuleMetadata() Returns all the metadata associated with this deployment
<T> T	getModuleMetaData(Class<T> metadataType) Returns the meta data associated with a module type.
Properties	getModuleProps() Returns the module level properties that will be persisted as a key value pair at then end of deployment.
Map<String,Properties>	getModulePropsMap() Gets the module properties for modules
String	getModuleUri() Gets the module uri for this module context
ReadableArchive	getOriginalSource() Gets the original source archive In case of archive deployment, this will return the archive before expanding.
ExtendedDeploymentContext	getParentContext() Gets the parent context of the module
ExtendedDeploymentContext.Phase	getPhase()
File	getScratchDir(String subDirName) Returns a scratch directory that can be used to store things in.
ReadableArchive	getSource() Application bits, at the raw level.
File	getSourceDir() Returns the directory where the original applications bits should be stored.
String	getTenant() Returns the tenant, if one is valid for this DeploymentContext.
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.
List<ClassFileTransformer>	getTransformers() Returns the list of transformers registered to this context.
Map<String,Object>	getTransientAppMetadata() Returns all the transient app metadata associated with this deployment
<T> T	getTransientAppMetaData(String key, Class<T> metadataType) Returns the meta data for the given key
void	postDeployClean(boolean isFinalClean) Performs any clean-up of the deployment context after deployment has finished.
void	preDestroy()
void	prepareScratchDirs() Prepare the scratch directories, creating the directories if they do not exist
void	setArchiveHandler(ArchiveHandler archiveHandler) Sets the archive handler that's associated with this context
void	setClassLoader(ClassLoader cloader) Sets the classloader
void	setModulePropsMap(Map<String,Properties> modulePropsMap) Sets the module properties for modules
void	setModuleUri(String moduleUri) Sets the module uri for this module context
void	setParentContext(ExtendedDeploymentContext parentContext) Sets the parent context for the module
void	setPhase(ExtendedDeploymentContext.Phase newPhase) Sets the phase of the deployment activity.
void	setSource(ReadableArchive source) Sets the source archive
void	setTenant(String tenant, String appName) Sets the tenant to which this deployment context applies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deplLogger

public static final Logger deplLogger

Constructor Detail

DeploymentContextImpl

public DeploymentContextImpl(Deployment.DeploymentContextBuilder builder,
                             ServerEnvironment env)

Creates a new instance of DeploymentContext

DeploymentContextImpl

public DeploymentContextImpl(ActionReport actionReport,
                             Logger logger,
                             ReadableArchive source,
                             OpsParams params,
                             ServerEnvironment env)

DeploymentContextImpl

public DeploymentContextImpl(ActionReport actionReport,
                             ReadableArchive source,
                             OpsParams params,
                             ServerEnvironment env)

Method Detail

getPhase

public ExtendedDeploymentContext.Phase getPhase()

Specified by:

getPhase in interface ExtendedDeploymentContext

setPhase

public void setPhase(ExtendedDeploymentContext.Phase newPhase)

Description copied from interface: ExtendedDeploymentContext

Sets the phase of the deployment activity.

Specified by:

setPhase in interface ExtendedDeploymentContext

getSource

public ReadableArchive getSource()

Description copied from interface: DeploymentContext

Application bits, at the raw level. Deployer's should avoid using such low level access as it binds the deployer to a particular directory layout. Instead Deployers should use the class loader obtained via the getClassLoader() API

Specified by:

getSource in interface DeploymentContext

Returns:

Abstraction to the application's source archive.

setSource

public void setSource(ReadableArchive source)

Description copied from interface: ExtendedDeploymentContext

Sets the source archive

Specified by:

setSource in interface ExtendedDeploymentContext

getCommandParameters

public <U extends OpsParams> U getCommandParameters(Class<U> commandParametersType)

Description copied from interface: DeploymentContext

Returns the DeployCommand parameters

Specified by:

getCommandParameters in interface DeploymentContext

Parameters:

commandParametersType - expected deployment operation parameters type.

Returns:

the command parameters

getLogger

public Logger getLogger()

Description copied from interface: ExecutionContext

Returns the logger services implementation should use to log useful information about their execution.

Specified by:

getLogger in interface ExecutionContext

Returns:

the services logger

preDestroy

public void preDestroy()

Specified by:

preDestroy in interface org.glassfish.hk2.api.PreDestroy

getFinalClassLoader

public ClassLoader getFinalClassLoader()

Returns the class loader associated to this deployment request. ClassLoader instances are usually obtained by the getClassLoader API on the associated ArchiveHandler for the archive type being deployed.

This can return null and the container should allocate a ClassLoader while loading the application.

Specified by:

getFinalClassLoader in interface DeploymentContext

Returns:

a class loader capable of loading classes and resources from the source

getClassLoader

public ClassLoader getClassLoader()

Returns the class loader associated to this deployment request. ClassLoader instances are usually obtained by the getClassLoader API on the associated ArchiveHandler for the archive type being deployed.

This can return null and the container should allocate a ClassLoader while loading the application.

Specified by:

getClassLoader in interface ApplicationContext

Returns:

a class loader capable of loading classes and resources from the source

setClassLoader

public void setClassLoader(ClassLoader cloader)

Description copied from interface: ExtendedDeploymentContext

Sets the classloader

Specified by:

setClassLoader in interface ExtendedDeploymentContext

createDeploymentClassLoader

public void createDeploymentClassLoader(ClassLoaderHierarchy clh,
                                        ArchiveHandler handler)
                                 throws URISyntaxException,
                                        MalformedURLException

Description copied from interface: ExtendedDeploymentContext

Create the deployment class loader. It will be used for sniffer retrieval, metadata parsing and deployer prepare.

Specified by:

createDeploymentClassLoader in interface ExtendedDeploymentContext

Parameters:

clh - the hierarchy of class loader for the parent

handler - the archive handler for the source archive

Throws:

URISyntaxException

MalformedURLException

createApplicationClassLoader

public void createApplicationClassLoader(ClassLoaderHierarchy clh,
                                         ArchiveHandler handler)
                                  throws URISyntaxException,
                                         MalformedURLException

Description copied from interface: ExtendedDeploymentContext

Create the final class loader. It will be used to load and start application.

Specified by:

createApplicationClassLoader in interface ExtendedDeploymentContext

Parameters:

clh - the hierarchy of class loader for the parent

handler - the archive handler for the source archive

Throws:

URISyntaxException

MalformedURLException

getClassLoader

public ClassLoader getClassLoader(boolean sharable)

getScratchDir

public File getScratchDir(String subDirName)

Returns a scratch directory that can be used to store things in. The scratch directory will be persisted accross server restart but not accross redeployment of the same application

Specified by:

getScratchDir in interface DeploymentContext

Parameters:

subDirName - the sub directory name of the scratch dir

Returns:

the scratch directory for this application based on passed in subDirName. Returns the root scratch dir if the passed in value is null.

getSourceDir

public File getSourceDir()

Returns the directory where the original applications bits should be stored. This is useful when users deploy an archive file that need to be unzipped somewhere for the container to work with.

Specified by:

getSourceDir in interface DeploymentContext

Returns:

the source directory for this application

addModuleMetaData

public void addModuleMetaData(Object metaData)

Description copied from interface: DeploymentContext

Stores a descriptor for the module in the context so other deployer's can have access to it. Module meta-data is usual not persistent which mean that any modification to it will not be available at the next server restart and will need to be reset.

Specified by:

addModuleMetaData in interface DeploymentContext

Parameters:

metaData - the meta data itself

getModuleMetaData

public <T> T getModuleMetaData(Class<T> metadataType)

Description copied from interface: DeploymentContext

Returns the meta data associated with a module type.

Specified by:

getModuleMetaData in interface DeploymentContext

Parameters:

metadataType - type of the meta date.

Returns:

instance of T or null

getModuleMetadata

public Collection<Object> getModuleMetadata()

Description copied from interface: DeploymentContext

Returns all the metadata associated with this deployment

Specified by:

getModuleMetadata in interface DeploymentContext

Returns:

collection of metadata added to the context

getTransientAppMetadata

public Map<String,Object> getTransientAppMetadata()

Description copied from interface: DeploymentContext

Returns all the transient app metadata associated with this deployment

Specified by:

getTransientAppMetadata in interface DeploymentContext

Returns:

collection of metadata added to the context

addTransientAppMetaData

public void addTransientAppMetaData(String metaDataKey,
                                    Object metaData)

Description copied from interface: DeploymentContext

Stores application level metadata in the context so other deployer's can have access to it. The transient meta-data is not persistent which mean that any modification to it will not be available at the next server restart and will need to be reset.

Specified by:

addTransientAppMetaData in interface DeploymentContext

Parameters:

metaDataKey - key of the meta date.

metaData - the meta data itself

getTransientAppMetaData

public <T> T getTransientAppMetaData(String key,
                                     Class<T> metadataType)

Description copied from interface: DeploymentContext

Returns the meta data for the given key

Specified by:

getTransientAppMetaData in interface DeploymentContext

Parameters:

key - key of the meta date.

metadataType - type of the meta date.

Returns:

instance of T or null

getAppProps

public Properties getAppProps()

Returns the application level properties that will be persisted as a key value pair at then end of deployment. That allows individual Deployers implementation to store some information at the application level that should be available upon server restart. Application level propertries are shared by all the modules.

Specified by:

getAppProps in interface ApplicationContext

Returns:

the application's properties.

getModuleProps

public Properties getModuleProps()

Returns the module level properties that will be persisted as a key value pair at then end of deployment. That allows individual Deployers implementation to store some information at the module level that should be available upon server restart. Module level properties are only visible to the current module.

Specified by:

getModuleProps in interface ApplicationContext

Returns:

the module's properties.

addTransformer

public void addTransformer(ClassFileTransformer transformer)

Add a new ClassFileTransformer to the context

Specified by:

addTransformer in interface DeploymentContext

Parameters:

transformer - the new class file transformer to register to the new application class loader

Throws:

UnsupportedOperationException - if the class loader we use does not support the registration of a ClassFileTransformer. In such case, the deployer should either fail deployment or revert to a mode without the byteocode enhancement feature.

getTransformers

public List<ClassFileTransformer> getTransformers()

Returns the list of transformers registered to this context.

Specified by:

getTransformers in interface ExtendedDeploymentContext

Returns:

the transformers list

getAppLibs

public List<URI> getAppLibs()
                     throws URISyntaxException

Description copied from interface: DeploymentContext

gets the app-libs specified for this archive
This list includes --libraries as well EXTENSION_LIST specified in the manifest entries

Specified by:

getAppLibs in interface DeploymentContext

Returns:

list of library URIs

Throws:

URISyntaxException - when unable to get the library URIs

clean

public void clean()

Specified by:

clean in interface ExtendedDeploymentContext

getArchiveHandler

public ArchiveHandler getArchiveHandler()

Description copied from interface: DeploymentContext

Returns the archive handler that's associated with this context

Specified by:

getArchiveHandler in interface DeploymentContext

Returns:

archive handler

setArchiveHandler

public void setArchiveHandler(ArchiveHandler archiveHandler)

Description copied from interface: ExtendedDeploymentContext

Sets the archive handler that's associated with this context

Specified by:

setArchiveHandler in interface ExtendedDeploymentContext

getOriginalSource

public ReadableArchive getOriginalSource()

Description copied from interface: DeploymentContext

Gets the original source archive In case of archive deployment, this will return the archive before expanding. In case of directory deployment, this will return the same thing as getSource()

Specified by:

getOriginalSource in interface DeploymentContext

Returns:

the original source archive

getModulePropsMap

public Map<String,Properties> getModulePropsMap()

Gets the module properties for modules

Specified by:

getModulePropsMap in interface DeploymentContext

Returns:

a map containing module properties

setModulePropsMap

public void setModulePropsMap(Map<String,Properties> modulePropsMap)

Sets the module properties for modules

Specified by:

setModulePropsMap in interface ExtendedDeploymentContext

Parameters:

modulePropsMap -

setParentContext

public void setParentContext(ExtendedDeploymentContext parentContext)

Sets the parent context for the module

Specified by:

setParentContext in interface ExtendedDeploymentContext

Parameters:

parentContext -

getParentContext

public ExtendedDeploymentContext getParentContext()

Gets the parent context of the module

Specified by:

getParentContext in interface ExtendedDeploymentContext

Returns:

the parent context

getModuleUri

public String getModuleUri()

Gets the module uri for this module context

Specified by:

getModuleUri in interface ExtendedDeploymentContext

Returns:

the module uri

setModuleUri

public void setModuleUri(String moduleUri)

Sets the module uri for this module context

Specified by:

setModuleUri in interface ExtendedDeploymentContext

Parameters:

moduleUri -

getModuleArchiveHandlers

public Map<String,ArchiveHandler> getModuleArchiveHandlers()

Gets the archive handlers for modules

Specified by:

getModuleArchiveHandlers in interface DeploymentContext

Returns:

a map containing module archive handlers

getModuleDeploymentContexts

public Map<String,ExtendedDeploymentContext> getModuleDeploymentContexts()

Gets the deployment context for modules

Specified by:

getModuleDeploymentContexts in interface ExtendedDeploymentContext

Returns:

a map containing module deployment contexts

getActionReport

public ActionReport getActionReport()

Gets the action report for this context

Specified by:

getActionReport in interface DeploymentContext

Returns:

an action report

getAppInternalDir

public File getAppInternalDir()

Description copied from interface: ExtendedDeploymentContext

Returns the internal directory for the application (used for holding the uploaded archive, for example).

Specified by:

getAppInternalDir in interface ExtendedDeploymentContext

Returns:

location of the internal directory for the application

getAppAltDDDir

public File getAppAltDDDir()

Description copied from interface: ExtendedDeploymentContext

Returns the alternate deployment descriptor directory for the application (used for holding the external alternate deployment descriptors).

Specified by:

getAppAltDDDir in interface ExtendedDeploymentContext

Returns:

location of the alternate deployment descriptor directory for the application

setTenant

public void setTenant(String tenant,
                      String appName)

Description copied from interface: ExtendedDeploymentContext

Sets the tenant to which this deployment context applies. Also initializes the tenant directory.

Specified by:

setTenant in interface ExtendedDeploymentContext

appName - the name of the application

getTenant

public String getTenant()

Description copied from interface: ExtendedDeploymentContext

Returns the tenant, if one is valid for this DeploymentContext.

Specified by:

getTenant in interface ExtendedDeploymentContext

Returns:

tenant name if applicable, null if no tenant is set for this DC

getTenantDir

public File getTenantDir()

Description copied from interface: ExtendedDeploymentContext

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.

Specified by:

getTenantDir in interface ExtendedDeploymentContext

Returns:

directory containing the expanded customization archive; null if none

postDeployClean

public void postDeployClean(boolean isFinalClean)

Description copied from interface: ExtendedDeploymentContext

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.)

Specified by:

postDeployClean in interface ExtendedDeploymentContext

Parameters:

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

prepareScratchDirs

public void prepareScratchDirs()
                        throws IOException

Prepare the scratch directories, creating the directories if they do not exist

Specified by:

prepareScratchDirs in interface ExtendedDeploymentContext

Throws:

IOException