org.apache.maven.plugins.war

Class AbstractWarMojo.DefaultWarPackagingContext

java.lang.Object

org.apache.maven.plugins.war.AbstractWarMojo.DefaultWarPackagingContext

All Implemented Interfaces:

WarPackagingContext

Enclosing class:

AbstractWarMojo

private class AbstractWarMojo.DefaultWarPackagingContext
extends java.lang.Object
implements WarPackagingContext

WarPackagingContext default implementation

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
private boolean	filteringDeploymentDescriptors
private java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	filterWrappers
private java.util.List<java.lang.String>	nonFilteredFileExtensions
private OverlayManager	overlayManager
private java.lang.String	resourceEncoding
private boolean	useJvmChmod
private java.io.File	webappDirectory
private WebappStructure	webappStructure

Constructor Summary

Constructors

Constructor and Description

DefaultWarPackagingContext(java.io.File webappDirectory, WebappStructure webappStructure, OverlayManager overlayManager, java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers, java.util.List<java.lang.String> nonFilteredFileExtensions, boolean filteringDeploymentDescriptors, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, java.lang.String resourceEncoding, boolean useJvmChmod)

Method Summary

Modifier and Type	Method and Description
boolean	archiveClasses() Specify whether the classes resources should be archived in the WEB-INF/lib of the generated web app.
org.apache.maven.archiver.MavenArchiveConfiguration	getArchive() The maven archive configuration to use.
org.codehaus.plexus.archiver.manager.ArchiverManager	getArchiverManager() Returns the archiver manager to use.
org.apache.maven.artifact.factory.ArtifactFactory	getArtifactFactory()
java.io.File	getClassesDirectory() Returns the directory holding generated classes.
java.util.List<java.lang.String>	getFilters() Returns the list of filter files to use.
java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getFilterWrappers()
org.codehaus.plexus.archiver.jar.JarArchiver	getJarArchiver() Returns the Jar archiver needed for archiving classes directory into jar file under WEB-INF/lib.
org.apache.maven.plugin.logging.Log	getLog() Returns the logger to use to output logging event.
org.apache.maven.shared.filtering.MavenFileFilter	getMavenFileFilter() Returns the MavenFileFilter instance to use.
java.lang.String	getOutputFileNameMapping() Returns the output file name mapping to use, if any.
java.io.File	getOverlaysWorkDirectory() Returns the directory to unpack dependent WARs into if needed.
java.util.List<java.lang.String>	getOwnerIds() Returns the list of registered overlays for this session.
org.apache.maven.project.MavenProject	getProject() Returns the maven project.
java.lang.String	getResourceEncoding() Returns the encoding to use for resources.
org.apache.maven.execution.MavenSession	getSession() Returns the Maven session.
java.io.File	getWebappDirectory() Returns the webapp directory.
java.io.File	getWebappSourceDirectory() Returns the main webapp source directory.
java.lang.String[]	getWebappSourceExcludes() Returns the webapp source excludes.
java.lang.String[]	getWebappSourceIncludes() Returns the webapp source includes.
WebappStructure	getWebappStructure() Returns the WebappStructure.
boolean	isFilteringDeploymentDescriptors()
boolean	isNonFilteredExtension(java.lang.String fileName) Specify if the given fileName belongs to the list of extensions that must not be filtered
boolean	isUseJvmChmod()
boolean	isWebappSourceIncludeEmptyDirectories() Returns true if empty directories should be includes, othewrwise false

Methods inherited from class java.lang.Object

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

Field Detail

artifactFactory

private final org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

resourceEncoding

private final java.lang.String resourceEncoding

webappStructure

private final WebappStructure webappStructure

webappDirectory

private final java.io.File webappDirectory

overlayManager

private final OverlayManager overlayManager

filterWrappers

private final java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers

nonFilteredFileExtensions

private java.util.List<java.lang.String> nonFilteredFileExtensions

filteringDeploymentDescriptors

private boolean filteringDeploymentDescriptors

useJvmChmod

private boolean useJvmChmod

Constructor Detail

DefaultWarPackagingContext

DefaultWarPackagingContext(java.io.File webappDirectory,
                           WebappStructure webappStructure,
                           OverlayManager overlayManager,
                           java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers,
                           java.util.List<java.lang.String> nonFilteredFileExtensions,
                           boolean filteringDeploymentDescriptors,
                           org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                           java.lang.String resourceEncoding,
                           boolean useJvmChmod)

Parameters:

webappDirectory - The web application directory.

webappStructure - The web app structure.

overlayManager - The overlay manager.

filterWrappers - The filter wrappers

nonFilteredFileExtensions - The non filtered file extensions.

filteringDeploymentDescriptors - The filtering deployment descriptors.

artifactFactory - The artifact factory.

resourceEncoding - The resource encoding.

useJvmChmod - use Jvm chmod or not.

Method Detail

getProject

public org.apache.maven.project.MavenProject getProject()

Returns the maven project.

Specified by:

getProject in interface WarPackagingContext

Returns:

the project

getWebappDirectory

public java.io.File getWebappDirectory()

Returns the webapp directory. Packaging tasks should use this directory to generate the webapp.

Specified by:

getWebappDirectory in interface WarPackagingContext

Returns:

the webapp directory

getClassesDirectory

public java.io.File getClassesDirectory()

Returns the directory holding generated classes.

Specified by:

getClassesDirectory in interface WarPackagingContext

Returns:

the classes directory

getLog

public org.apache.maven.plugin.logging.Log getLog()

Returns the logger to use to output logging event.

Specified by:

getLog in interface WarPackagingContext

Returns:

the logger

getOutputFileNameMapping

public java.lang.String getOutputFileNameMapping()

Returns the output file name mapping to use, if any. Returns null if no file name mapping is set.

Specified by:

getOutputFileNameMapping in interface WarPackagingContext

Returns:

the output file name mapping or null

getWebappSourceDirectory

public java.io.File getWebappSourceDirectory()

Returns the main webapp source directory.

Specified by:

getWebappSourceDirectory in interface WarPackagingContext

Returns:

the webapp source directory

getWebappSourceIncludes

public java.lang.String[] getWebappSourceIncludes()

Returns the webapp source includes.

Specified by:

getWebappSourceIncludes in interface WarPackagingContext

Returns:

the webapp source includes

getWebappSourceExcludes

public java.lang.String[] getWebappSourceExcludes()

Returns the webapp source excludes.

Specified by:

getWebappSourceExcludes in interface WarPackagingContext

Returns:

the webapp source excludes

isWebappSourceIncludeEmptyDirectories

public boolean isWebappSourceIncludeEmptyDirectories()

Returns true if empty directories should be includes, othewrwise false

Specified by:

isWebappSourceIncludeEmptyDirectories in interface WarPackagingContext

Returns:

true if empty directories should be includes, othewrwise false

archiveClasses

public boolean archiveClasses()

Specify whether the classes resources should be archived in the WEB-INF/lib of the generated web app.

Specified by:

archiveClasses in interface WarPackagingContext

Returns:

true if the classes should be archived, false otherwise

getOverlaysWorkDirectory

public java.io.File getOverlaysWorkDirectory()

Returns the directory to unpack dependent WARs into if needed.

Specified by:

getOverlaysWorkDirectory in interface WarPackagingContext

Returns:

the overlays work directory

getArchiverManager

public org.codehaus.plexus.archiver.manager.ArchiverManager getArchiverManager()

Returns the archiver manager to use.

Specified by:

getArchiverManager in interface WarPackagingContext

Returns:

the archiver manager

getArchive

public org.apache.maven.archiver.MavenArchiveConfiguration getArchive()

The maven archive configuration to use.

Specified by:

getArchive in interface WarPackagingContext

Returns:

the maven archive configuration

getJarArchiver

public org.codehaus.plexus.archiver.jar.JarArchiver getJarArchiver()

Returns the Jar archiver needed for archiving classes directory into jar file under WEB-INF/lib.

Specified by:

getJarArchiver in interface WarPackagingContext

Returns:

the jar archiver to user

getFilters

public java.util.List<java.lang.String> getFilters()

Returns the list of filter files to use.

Specified by:

getFilters in interface WarPackagingContext

Returns:

a list of filter files

getWebappStructure

public WebappStructure getWebappStructure()

Returns the WebappStructure.

Specified by:

getWebappStructure in interface WarPackagingContext

Returns:

the webapp structure

getOwnerIds

public java.util.List<java.lang.String> getOwnerIds()

Returns the list of registered overlays for this session. This list might differ from the one returned by the cache; in this case, it means that the project's configuration has changed. The plugin will handle those cases nicely but it would be better in general to invoke the clean goal.

Specified by:

getOwnerIds in interface WarPackagingContext

Returns:

the list of registered overlays, including the current project

getMavenFileFilter

public org.apache.maven.shared.filtering.MavenFileFilter getMavenFileFilter()

Returns the MavenFileFilter instance to use.

Specified by:

getMavenFileFilter in interface WarPackagingContext

Returns:

the maven file filter to use

getFilterWrappers

public java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getFilterWrappers()

Specified by:

getFilterWrappers in interface WarPackagingContext

Returns:

List of FileUtils.FilterWrapper

isNonFilteredExtension

public boolean isNonFilteredExtension(java.lang.String fileName)

Specify if the given fileName belongs to the list of extensions that must not be filtered

Specified by:

isNonFilteredExtension in interface WarPackagingContext

Parameters:

fileName - the name of file

Returns:

true if it should not be filtered, false otherwise

isFilteringDeploymentDescriptors

public boolean isFilteringDeploymentDescriptors()

Specified by:

isFilteringDeploymentDescriptors in interface WarPackagingContext

Returns:

filtering deployment descriptor.

getArtifactFactory

public org.apache.maven.artifact.factory.ArtifactFactory getArtifactFactory()

Specified by:

getArtifactFactory in interface WarPackagingContext

Returns:

ArtifactFactory

getSession

public org.apache.maven.execution.MavenSession getSession()

Returns the Maven session.

Specified by:

getSession in interface WarPackagingContext

Returns:

the Maven session

getResourceEncoding

public java.lang.String getResourceEncoding()

Returns the encoding to use for resources.

Specified by:

getResourceEncoding in interface WarPackagingContext

Returns:

the resource encoding

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface WarPackagingContext

Returns:

to use jvmChmod rather than forking chmod cli