Maven WAR Plugin
Builds a Web Application Archive (WAR) file from the project output and its dependencies.
org.apache.maven.plugins
maven-war-plugin
2.1.1-PATCH-AFKLM
war
false
true
manifest
Generate a manifest for this webapp. The manifest file is created in the
<code>warSourceDirectory</code>.
runtime
false
true
false
false
false
true
process-resources
org.apache.maven.plugin.war.WarManifestMojo
java
per-lookup
once-per-session
true
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
The archive configuration to use.
See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
archiveClasses
boolean
false
true
Whether a JAR file will be created for the classes in the webapp. Using this optional configuration
parameter will make the compiled classes to be archived into a JAR file
and the classes directory will then be excluded from the webapp.
cacheFile
java.io.File
true
true
The file containing the webapp structure cache.
classesDirectory
java.io.File
true
false
The directory containing compiled classes.
containerConfigXML
java.io.File
false
true
The path to a configuration file for the servlet container. Note that
the file name may be different for different servlet containers.
Apache Tomcat uses a configuration file named context.xml. The file will
be copied to the META-INF directory.
dependentWarExcludes
java.lang.String
Use <overlay>/<excludes> instead
false
true
The comma separated list of tokens to exclude when doing
a WAR overlay.
dependentWarIncludes
java.lang.String
Use <overlay>/<includes> instead
false
true
The comma separated list of tokens to include when doing
a WAR overlay.
Default is '**'
escapeString
java.lang.String
false
true
Expression preceded with this String won't be interpolated.
<code>\${foo}</code> will be replaced with <code>${foo}</code>.
escapedBackslashesInFilePath
boolean
false
true
To escape interpolated values with Windows path
<code>c:\foo\bar</code> will be replaced with <code>c:\\foo\\bar</code>.
filteringDeploymentDescriptors
boolean
false
true
To filter deployment descriptors. <b>Disabled by default.</b>
filters
java.util.List
false
true
Filters (property files) to include during the interpolation of the pom.xml.
nonFilteredFileExtensions
java.util.List
false
true
A list of file extensions that should not be filtered.
<b>Will be used when filtering webResources and overlays.</b>
outputFileNameMapping
java.lang.String
false
true
The file name mapping to use when copying libraries and TLDs. If no file mapping is
set (default) the files are copied with their standard names.
overlays
java.util.List
false
true
The overlays to apply.
project
org.apache.maven.project.MavenProject
true
false
The Maven project.
session
org.apache.maven.execution.MavenSession
true
false
useCache
boolean
false
true
Whether the cache should be used to save the status of the webapp
across multiple runs. Experimental feature so disabled by default.
warSourceDirectory
java.io.File
true
true
Single directory for extra files to include in the WAR. This is where
you place your JSP files.
warSourceExcludes
excludes
java.lang.String
false
true
The comma separated list of tokens to exclude when copying the content
of the warSourceDirectory.
warSourceIncludes
includes
java.lang.String
false
true
The comma separated list of tokens to include when copying the content
of the warSourceDirectory.
webResources
org.apache.maven.model.Resource[]
false
true
The list of webResources we want to transfer.
webXml
java.io.File
false
true
The path to the web.xml file to use.
webappDirectory
java.io.File
true
true
The directory where the webapp is built.
workDirectory
java.io.File
true
true
Directory to unpack dependent WARs into if needed.
${archiveClasses}
${maven.war.containerConfigXML}
${maven.war.escapeString}
${maven.war.escapedBackslashesInFilePath}
${maven.war.filteringDeploymentDescriptors}
${useCache}
${maven.war.webxml}
org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
org.apache.maven.artifact.factory.ArtifactFactory
artifactFactory
org.codehaus.plexus.archiver.Archiver
jar
jarArchiver
org.apache.maven.shared.filtering.MavenFileFilter
default
mavenFileFilter
org.apache.maven.shared.filtering.MavenResourcesFiltering
default
mavenResourcesFiltering
org.codehaus.plexus.archiver.Archiver
war
warArchiver
help
Display help information on maven-war-plugin.<br/> Call <pre> mvn war:help -Ddetail=true -Dgoal=<goal-name></pre> to display parameter details.
false
false
false
false
false
true
org.apache.maven.plugin.war.HelpMojo
java
per-lookup
once-per-session
false
detail
boolean
false
true
If <code>true</code>, display all settable properties for each goal.
goal
java.lang.String
false
true
The name of the goal for which to show help. If unspecified, all goals will be displayed.
indentSize
int
false
true
The number of spaces per indentation level, should be positive.
lineLength
int
false
true
The maximum length of a display line, should be positive.
${detail}
${goal}
${indentSize}
${lineLength}
war
Build a WAR file.
runtime
false
true
false
false
false
true
package
org.apache.maven.plugin.war.WarMojo
java
per-lookup
once-per-session
true
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
The archive configuration to use.
See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
archiveClasses
boolean
false
true
Whether a JAR file will be created for the classes in the webapp. Using this optional configuration
parameter will make the compiled classes to be archived into a JAR file
and the classes directory will then be excluded from the webapp.
attachClasses
boolean
false
true
Whether classes (that is the content of the WEB-INF/classes directory) should be attached to the
project.
cacheFile
java.io.File
true
true
The file containing the webapp structure cache.
classesClassifier
java.lang.String
false
true
The classifier to use for the attached classes artifact.
classesDirectory
java.io.File
true
false
The directory containing compiled classes.
classifier
java.lang.String
false
true
Classifier to add to the generated WAR. If given, the artifact will be an attachment instead.
The classifier will not be applied to the JAR file of the project - only to the WAR file.
containerConfigXML
java.io.File
false
true
The path to a configuration file for the servlet container. Note that
the file name may be different for different servlet containers.
Apache Tomcat uses a configuration file named context.xml. The file will
be copied to the META-INF directory.
dependentWarExcludes
java.lang.String
Use <overlay>/<excludes> instead
false
true
The comma separated list of tokens to exclude when doing
a WAR overlay.
dependentWarIncludes
java.lang.String
Use <overlay>/<includes> instead
false
true
The comma separated list of tokens to include when doing
a WAR overlay.
Default is '**'
escapeString
java.lang.String
false
true
Expression preceded with this String won't be interpolated.
<code>\${foo}</code> will be replaced with <code>${foo}</code>.
escapedBackslashesInFilePath
boolean
false
true
To escape interpolated values with Windows path
<code>c:\foo\bar</code> will be replaced with <code>c:\\foo\\bar</code>.
failOnMissingWebXml
boolean
false
true
Whether or not to fail the build if the <code>web.xml</code> file is missing. Set to <code>false</code>
if you want you WAR built without a <code>web.xml</code> file.
This may be useful if you are building an overlay that has no web.xml file.
filteringDeploymentDescriptors
boolean
false
true
To filter deployment descriptors. <b>Disabled by default.</b>
filters
java.util.List
false
true
Filters (property files) to include during the interpolation of the pom.xml.
nonFilteredFileExtensions
java.util.List
false
true
A list of file extensions that should not be filtered.
<b>Will be used when filtering webResources and overlays.</b>
outputDirectory
java.lang.String
true
true
The directory for the generated WAR.
outputFileNameMapping
java.lang.String
false
true
The file name mapping to use when copying libraries and TLDs. If no file mapping is
set (default) the files are copied with their standard names.
overlays
java.util.List
false
true
The overlays to apply.
packagingExcludes
java.lang.String
false
true
The comma separated list of tokens to exclude from the WAR before
packaging. This option may be used to implement the skinny WAR use
case.
packagingIncludes
java.lang.String
false
true
The comma separated list of tokens to include in the WAR before
packaging. By default everything is included. This option may be used
to implement the skinny WAR use case.
primaryArtifact
boolean
false
true
Whether this is the main artifact being built. Set to <code>false</code> if you don't want to install or
deploy it to the local repository instead of the default one in an execution.
project
org.apache.maven.project.MavenProject
true
false
The Maven project.
session
org.apache.maven.execution.MavenSession
true
false
useCache
boolean
false
true
Whether the cache should be used to save the status of the webapp
across multiple runs. Experimental feature so disabled by default.
warName
java.lang.String
true
true
The name of the generated WAR.
warSourceDirectory
java.io.File
true
true
Single directory for extra files to include in the WAR. This is where
you place your JSP files.
warSourceExcludes
excludes
java.lang.String
false
true
The comma separated list of tokens to exclude when copying the content
of the warSourceDirectory.
warSourceIncludes
includes
java.lang.String
false
true
The comma separated list of tokens to include when copying the content
of the warSourceDirectory.
webResources
org.apache.maven.model.Resource[]
false
true
The list of webResources we want to transfer.
webXml
java.io.File
false
true
The path to the web.xml file to use.
webappDirectory
java.io.File
true
true
The directory where the webapp is built.
workDirectory
java.io.File
true
true
Directory to unpack dependent WARs into if needed.
${archiveClasses}
${maven.war.containerConfigXML}
${maven.war.escapeString}
${maven.war.escapedBackslashesInFilePath}
${failOnMissingWebXml}
${maven.war.filteringDeploymentDescriptors}
${primaryArtifact}
${useCache}
${maven.war.webxml}
org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
org.apache.maven.artifact.factory.ArtifactFactory
artifactFactory
org.codehaus.plexus.archiver.Archiver
jar
jarArchiver
org.apache.maven.shared.filtering.MavenFileFilter
default
mavenFileFilter
org.apache.maven.shared.filtering.MavenResourcesFiltering
default
mavenResourcesFiltering
org.apache.maven.project.MavenProjectHelper
projectHelper
org.codehaus.plexus.archiver.Archiver
war
warArchiver
inplace
Generate the webapp in the WAR source directory.
runtime
false
true
false
false
false
true
org.apache.maven.plugin.war.WarInPlaceMojo
java
per-lookup
once-per-session
true
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
The archive configuration to use.
See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
archiveClasses
boolean
false
true
Whether a JAR file will be created for the classes in the webapp. Using this optional configuration
parameter will make the compiled classes to be archived into a JAR file
and the classes directory will then be excluded from the webapp.
cacheFile
java.io.File
true
true
The file containing the webapp structure cache.
classesDirectory
java.io.File
true
false
The directory containing compiled classes.
containerConfigXML
java.io.File
false
true
The path to a configuration file for the servlet container. Note that
the file name may be different for different servlet containers.
Apache Tomcat uses a configuration file named context.xml. The file will
be copied to the META-INF directory.
dependentWarExcludes
java.lang.String
Use <overlay>/<excludes> instead
false
true
The comma separated list of tokens to exclude when doing
a WAR overlay.
dependentWarIncludes
java.lang.String
Use <overlay>/<includes> instead
false
true
The comma separated list of tokens to include when doing
a WAR overlay.
Default is '**'
escapeString
java.lang.String
false
true
Expression preceded with this String won't be interpolated.
<code>\${foo}</code> will be replaced with <code>${foo}</code>.
escapedBackslashesInFilePath
boolean
false
true
To escape interpolated values with Windows path
<code>c:\foo\bar</code> will be replaced with <code>c:\\foo\\bar</code>.
filteringDeploymentDescriptors
boolean
false
true
To filter deployment descriptors. <b>Disabled by default.</b>
filters
java.util.List
false
true
Filters (property files) to include during the interpolation of the pom.xml.
nonFilteredFileExtensions
java.util.List
false
true
A list of file extensions that should not be filtered.
<b>Will be used when filtering webResources and overlays.</b>
outputFileNameMapping
java.lang.String
false
true
The file name mapping to use when copying libraries and TLDs. If no file mapping is
set (default) the files are copied with their standard names.
overlays
java.util.List
false
true
The overlays to apply.
project
org.apache.maven.project.MavenProject
true
false
The Maven project.
session
org.apache.maven.execution.MavenSession
true
false
useCache
boolean
false
true
Whether the cache should be used to save the status of the webapp
across multiple runs. Experimental feature so disabled by default.
warSourceDirectory
java.io.File
true
true
Single directory for extra files to include in the WAR. This is where
you place your JSP files.
warSourceExcludes
excludes
java.lang.String
false
true
The comma separated list of tokens to exclude when copying the content
of the warSourceDirectory.
warSourceIncludes
includes
java.lang.String
false
true
The comma separated list of tokens to include when copying the content
of the warSourceDirectory.
webResources
org.apache.maven.model.Resource[]
false
true
The list of webResources we want to transfer.
webXml
java.io.File
false
true
The path to the web.xml file to use.
webappDirectory
java.io.File
true
true
The directory where the webapp is built.
workDirectory
java.io.File
true
true
Directory to unpack dependent WARs into if needed.
${archiveClasses}
${maven.war.containerConfigXML}
${maven.war.escapeString}
${maven.war.escapedBackslashesInFilePath}
${maven.war.filteringDeploymentDescriptors}
${useCache}
${maven.war.webxml}
org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
org.apache.maven.artifact.factory.ArtifactFactory
artifactFactory
org.codehaus.plexus.archiver.Archiver
jar
jarArchiver
org.apache.maven.shared.filtering.MavenFileFilter
default
mavenFileFilter
org.apache.maven.shared.filtering.MavenResourcesFiltering
default
mavenResourcesFiltering
exploded
Create an exploded webapp in a specified directory.
runtime
false
true
false
false
false
true
package
org.apache.maven.plugin.war.WarExplodedMojo
java
per-lookup
once-per-session
true
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
The archive configuration to use.
See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
archiveClasses
boolean
false
true
Whether a JAR file will be created for the classes in the webapp. Using this optional configuration
parameter will make the compiled classes to be archived into a JAR file
and the classes directory will then be excluded from the webapp.
cacheFile
java.io.File
true
true
The file containing the webapp structure cache.
classesDirectory
java.io.File
true
false
The directory containing compiled classes.
containerConfigXML
java.io.File
false
true
The path to a configuration file for the servlet container. Note that
the file name may be different for different servlet containers.
Apache Tomcat uses a configuration file named context.xml. The file will
be copied to the META-INF directory.
dependentWarExcludes
java.lang.String
Use <overlay>/<excludes> instead
false
true
The comma separated list of tokens to exclude when doing
a WAR overlay.
dependentWarIncludes
java.lang.String
Use <overlay>/<includes> instead
false
true
The comma separated list of tokens to include when doing
a WAR overlay.
Default is '**'
escapeString
java.lang.String
false
true
Expression preceded with this String won't be interpolated.
<code>\${foo}</code> will be replaced with <code>${foo}</code>.
escapedBackslashesInFilePath
boolean
false
true
To escape interpolated values with Windows path
<code>c:\foo\bar</code> will be replaced with <code>c:\\foo\\bar</code>.
filteringDeploymentDescriptors
boolean
false
true
To filter deployment descriptors. <b>Disabled by default.</b>
filters
java.util.List
false
true
Filters (property files) to include during the interpolation of the pom.xml.
nonFilteredFileExtensions
java.util.List
false
true
A list of file extensions that should not be filtered.
<b>Will be used when filtering webResources and overlays.</b>
outputFileNameMapping
java.lang.String
false
true
The file name mapping to use when copying libraries and TLDs. If no file mapping is
set (default) the files are copied with their standard names.
overlays
java.util.List
false
true
The overlays to apply.
project
org.apache.maven.project.MavenProject
true
false
The Maven project.
session
org.apache.maven.execution.MavenSession
true
false
useCache
boolean
false
true
Whether the cache should be used to save the status of the webapp
across multiple runs. Experimental feature so disabled by default.
warSourceDirectory
java.io.File
true
true
Single directory for extra files to include in the WAR. This is where
you place your JSP files.
warSourceExcludes
excludes
java.lang.String
false
true
The comma separated list of tokens to exclude when copying the content
of the warSourceDirectory.
warSourceIncludes
includes
java.lang.String
false
true
The comma separated list of tokens to include when copying the content
of the warSourceDirectory.
webResources
org.apache.maven.model.Resource[]
false
true
The list of webResources we want to transfer.
webXml
java.io.File
false
true
The path to the web.xml file to use.
webappDirectory
java.io.File
true
true
The directory where the webapp is built.
workDirectory
java.io.File
true
true
Directory to unpack dependent WARs into if needed.
${archiveClasses}
${maven.war.containerConfigXML}
${maven.war.escapeString}
${maven.war.escapedBackslashesInFilePath}
${maven.war.filteringDeploymentDescriptors}
${useCache}
${maven.war.webxml}
org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
org.apache.maven.artifact.factory.ArtifactFactory
artifactFactory
org.codehaus.plexus.archiver.Archiver
jar
jarArchiver
org.apache.maven.shared.filtering.MavenFileFilter
default
mavenFileFilter
org.apache.maven.shared.filtering.MavenResourcesFiltering
default
mavenResourcesFiltering
org.apache.maven
maven-plugin-api
jar
2.0.6
org.apache.maven
maven-artifact
jar
2.0.6
org.apache.maven
maven-model
jar
2.0.6
org.apache.maven
maven-project
jar
2.0.6
org.apache.maven
maven-profile
jar
2.0.6
org.apache.maven
maven-artifact-manager
jar
2.0.6
org.apache.maven
maven-plugin-registry
jar
2.0.6
org.apache.maven
maven-core
jar
2.0.6
org.apache.maven.wagon
wagon-file
jar
1.0-beta-2
org.apache.maven
maven-plugin-parameter-documenter
jar
2.0.6
org.apache.maven.wagon
wagon-http-lightweight
jar
1.0-beta-2
org.apache.maven.wagon
wagon-http-shared
jar
1.0-beta-2
jtidy
jtidy
jar
4aug2000r7-dev
xml-apis
xml-apis
jar
1.0.b2
org.apache.maven.reporting
maven-reporting-api
jar
2.0.6
org.apache.maven.doxia
doxia-sink-api
jar
1.0-alpha-7
org.apache.maven.wagon
wagon-provider-api
jar
1.0-beta-2
org.apache.maven
maven-repository-metadata
jar
2.0.6
org.apache.maven
maven-error-diagnostics
jar
2.0.6
commons-cli
commons-cli
jar
1.0
org.apache.maven.wagon
wagon-ssh-external
jar
1.0-beta-2
org.apache.maven.wagon
wagon-ssh-common
jar
1.0-beta-2
org.apache.maven
maven-plugin-descriptor
jar
2.0.6
org.codehaus.plexus
plexus-interactivity-api
jar
1.0-alpha-4
org.apache.maven.wagon
wagon-ssh
jar
1.0-beta-2
com.jcraft
jsch
jar
0.1.27
classworlds
classworlds
jar
1.1
org.apache.maven
maven-settings
jar
2.0.6
org.apache.maven
maven-monitor
jar
2.0.6
org.apache.maven
maven-archiver
jar
2.4.1
org.codehaus.plexus
plexus-archiver
jar
1.2
org.codehaus.plexus
plexus-io
jar
1.0.1
org.codehaus.plexus
plexus-interpolation
jar
1.13
org.codehaus.plexus
plexus-container-default
jar
1.0-alpha-9-stable-1
com.thoughtworks.xstream
xstream
jar
1.3.1
xpp3
xpp3_min
jar
1.1.4c
org.codehaus.plexus
plexus-utils
jar
2.0.5
org.apache.maven.shared
maven-filtering
jar
1.0-beta-2