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 Object
implements WarPackagingContext

WarPackagingContext default implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.apache.maven.artifact.handler.manager.ArtifactHandlerManager	artifactHandlerManager
private final Boolean	failOnMissingWebXml
private boolean	filteringDeploymentDescriptors
private final List<org.apache.maven.shared.filtering.FilterWrapper>	filterWrappers
private List<String>	nonFilteredFileExtensions
private final Collection<String>	outdatedResources
private final String	outputTimestamp
private final OverlayManager	overlayManager
private final String	propertiesEncoding
private final String	resourceEncoding
private final File	webappDirectory
private final WebappStructure	webappStructure

Constructor Summary

Constructors

Constructor

Description

DefaultWarPackagingContext(File webappDirectory, WebappStructure webappStructure, OverlayManager overlayManager, List<org.apache.maven.shared.filtering.FilterWrapper> filterWrappers, List<String> nonFilteredFileExtensions, boolean filteringDeploymentDescriptors, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, String resourceEncoding, String propertiesEncoding, Boolean failOnMissingWebXml, String outputTimestamp)

Method Summary

Modifier and Type	Method	Description
void	addResource(String resource)	Add a live resource to the war.
boolean	archiveClasses()	Specify whether the classes resources should be archived in the WEB-INF/lib of the generated web app.
protected boolean	checkAllPathsForOutdated()
void	deleteOutdatedResources()	Delete outdated resources, ie resources that are found in the war but that were not added by the current packaging process, then are supposed to be content from a previous run.
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.handler.manager.ArtifactHandlerManager	getArtifactHandlerManager()	Returns the artifact handler manager.
File	getClassesDirectory()	Returns the directory holding generated classes.
List<String>	getFilters()	Returns the list of filter files to use.
List<org.apache.maven.shared.filtering.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.
String	getOutputFileNameMapping()	Returns the output file name mapping to use, if any.
String	getOutputTimestamp()	Output timestamp for reproducible archive creation.
File	getOverlaysWorkDirectory()	Returns the directory to unpack dependent WARs into if needed.
List<String>	getOwnerIds()	Returns the list of registered overlays for this session.
List<String>	getPackagingExcludes()
List<String>	getPackagingIncludes()
org.apache.maven.project.MavenProject	getProject()	Returns the maven project.
String	getPropertiesEncoding()	Returns the encoding to use for resources that are properties files.
String	getResourceEncoding()	Returns the encoding to use for resources.
org.apache.maven.execution.MavenSession	getSession()	Returns the Maven session.
File	getWebappDirectory()	Returns the webapp directory.
File	getWebappSourceDirectory()	Returns the main webapp source directory.
String[]	getWebappSourceExcludes()	Returns the webapp source excludes.
String[]	getWebappSourceIncludes()	Returns the webapp source includes.
WebappStructure	getWebappStructure()	Returns the WebappStructure.
Boolean	isFailOnMissingWebXml()	Returns the flag that switch on/off the missing web.xml validation.
boolean	isFilteringDeploymentDescriptors()
boolean	isNonFilteredExtension(String fileName)	Specify if the given fileName belongs to the list of extensions that must not be filtered.
boolean	isWebappSourceIncludeEmptyDirectories()	Returns true if empty directories should be includes, otherwise false

Methods inherited from class Object

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

Field Details

artifactHandlerManager

private final org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager

resourceEncoding

private final String resourceEncoding

propertiesEncoding

private final String propertiesEncoding

webappStructure

private final WebappStructure webappStructure

webappDirectory

private final File webappDirectory

overlayManager

private final OverlayManager overlayManager

filterWrappers

private final List<org.apache.maven.shared.filtering.FilterWrapper> filterWrappers

nonFilteredFileExtensions

private List<String> nonFilteredFileExtensions

filteringDeploymentDescriptors

private boolean filteringDeploymentDescriptors

failOnMissingWebXml

private final Boolean failOnMissingWebXml

outdatedResources

private final Collection<String> outdatedResources

outputTimestamp

private final String outputTimestamp

Constructor Details

DefaultWarPackagingContext

DefaultWarPackagingContext(File webappDirectory,
 WebappStructure webappStructure,
 OverlayManager overlayManager,
 List<org.apache.maven.shared.filtering.FilterWrapper> filterWrappers,
 List<String> nonFilteredFileExtensions,
 boolean filteringDeploymentDescriptors,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 String resourceEncoding,
 String propertiesEncoding,
 Boolean failOnMissingWebXml,
 String outputTimestamp)

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

artifactHandlerManager - the artifact handler manager

resourceEncoding - the resource encoding

propertiesEncoding - the encoding to use for properties files

failOnMissingWebXml - flag to check whether we should ignore missing web.xml or not

outputTimestamp - the output timestamp for reproducible archive creation

Method Details

checkAllPathsForOutdated

protected boolean checkAllPathsForOutdated()

getProject

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

Description copied from interface: WarPackagingContext

Returns the maven project.

Specified by:

getProject in interface WarPackagingContext

Returns:

the project

getWebappDirectory

public File getWebappDirectory()

Description copied from interface: WarPackagingContext

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 File getClassesDirectory()

Description copied from interface: WarPackagingContext

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

Description copied from interface: WarPackagingContext

Returns the logger to use to output logging event.

Specified by:

getLog in interface WarPackagingContext

Returns:

the logger

getOutputFileNameMapping

public String getOutputFileNameMapping()

Description copied from interface: WarPackagingContext

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 File getWebappSourceDirectory()

Description copied from interface: WarPackagingContext

Returns the main webapp source directory.

Specified by:

getWebappSourceDirectory in interface WarPackagingContext

Returns:

the webapp source directory

getWebappSourceIncludes

public String[] getWebappSourceIncludes()

Description copied from interface: WarPackagingContext

Returns the webapp source includes.

Specified by:

getWebappSourceIncludes in interface WarPackagingContext

Returns:

the webapp source includes

getWebappSourceExcludes

public String[] getWebappSourceExcludes()

Description copied from interface: WarPackagingContext

Returns the webapp source excludes.

Specified by:

getWebappSourceExcludes in interface WarPackagingContext

Returns:

the webapp source excludes

isWebappSourceIncludeEmptyDirectories

public boolean isWebappSourceIncludeEmptyDirectories()

Description copied from interface: WarPackagingContext

Returns true if empty directories should be includes, otherwise false

Specified by:

isWebappSourceIncludeEmptyDirectories in interface WarPackagingContext

Returns:

true if empty directories should be includes, otherwise false

archiveClasses

public boolean archiveClasses()

Description copied from interface: WarPackagingContext

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 File getOverlaysWorkDirectory()

Description copied from interface: WarPackagingContext

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

Description copied from interface: WarPackagingContext

Returns the archiver manager to use.

Specified by:

getArchiverManager in interface WarPackagingContext

Returns:

the archiver manager

getArchive

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

Description copied from interface: WarPackagingContext

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

Description copied from interface: WarPackagingContext

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 List<String> getFilters()

Description copied from interface: WarPackagingContext

Returns the list of filter files to use.

Specified by:

getFilters in interface WarPackagingContext

Returns:

a list of filter files

getWebappStructure

public WebappStructure getWebappStructure()

Description copied from interface: WarPackagingContext

Returns the WebappStructure.

Specified by:

getWebappStructure in interface WarPackagingContext

Returns:

the webapp structure

getOwnerIds

public List<String> getOwnerIds()

Description copied from interface: WarPackagingContext

Returns the list of registered overlays for this session.

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

Description copied from interface: WarPackagingContext

Returns the MavenFileFilter instance to use.

Specified by:

getMavenFileFilter in interface WarPackagingContext

Returns:

the maven file filter to use

getFilterWrappers

public List<org.apache.maven.shared.filtering.FilterWrapper> getFilterWrappers()

Specified by:

getFilterWrappers in interface WarPackagingContext

Returns:

List of FilterWrapper

isNonFilteredExtension

public boolean isNonFilteredExtension(String fileName)

Description copied from interface: WarPackagingContext

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

getArtifactHandlerManager

public org.apache.maven.artifact.handler.manager.ArtifactHandlerManager getArtifactHandlerManager()

Description copied from interface: WarPackagingContext

Returns the artifact handler manager.

Specified by:

getArtifactHandlerManager in interface WarPackagingContext

Returns:

the artifact handler manager

getSession

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

Description copied from interface: WarPackagingContext

Returns the Maven session.

Specified by:

getSession in interface WarPackagingContext

Returns:

the Maven session

getResourceEncoding

public String getResourceEncoding()

Description copied from interface: WarPackagingContext

Returns the encoding to use for resources.

Specified by:

getResourceEncoding in interface WarPackagingContext

Returns:

the resource encoding

getPropertiesEncoding

public String getPropertiesEncoding()

Description copied from interface: WarPackagingContext

Returns the encoding to use for resources that are properties files.

Specified by:

getPropertiesEncoding in interface WarPackagingContext

Returns:

the encoding for properties files

isFailOnMissingWebXml

public Boolean isFailOnMissingWebXml()

Description copied from interface: WarPackagingContext

Returns the flag that switch on/off the missing web.xml validation.

Specified by:

isFailOnMissingWebXml in interface WarPackagingContext

Returns:

failOnMissingWebXml

addResource

public void addResource(String resource)

Description copied from interface: WarPackagingContext

Add a live resource to the war. Used to keep track of existing resources and all copied files. All others are outdated and will be removed. This prevent calling mvn clean when resources are removed.

Specified by:

addResource in interface WarPackagingContext

Parameters:

resource - the resource that is to me marked as not outdated

See Also:

• WarPackagingContext.deleteOutdatedResources()

deleteOutdatedResources

public void deleteOutdatedResources()

Description copied from interface: WarPackagingContext

Delete outdated resources, ie resources that are found in the war but that were not added by the current packaging process, then are supposed to be content from a previous run. This prevent calling mvn clean when resources are removed.

Specified by:

deleteOutdatedResources in interface WarPackagingContext

See Also:

• WarPackagingContext.addResource(String)

getOutputTimestamp

public String getOutputTimestamp()

Description copied from interface: WarPackagingContext

Output timestamp for reproducible archive creation.

Specified by:

getOutputTimestamp in interface WarPackagingContext

Returns:

the output timestamp (may be null)

getPackagingExcludes

public List<String> getPackagingExcludes()

Specified by:

getPackagingExcludes in interface WarPackagingContext

Returns:

list of packaging excludes

Since:

3.4.1

getPackagingIncludes

public List<String> getPackagingIncludes()

Specified by:

getPackagingIncludes in interface WarPackagingContext

Returns:

list of packaging includes

Since:

3.4.1