Full name:
org.apache.maven.plugins:maven-war-plugin:2.1.1:war
Description:
Attributes:
runtime
.package
.Name | Type | Since | Description |
---|---|---|---|
cacheFile | File |
2.1-alpha-1 |
The file containing the webapp structure cache. Default value is: ${project.build.directory}/war/work/webapp-cache.xml . |
outputDirectory | String |
- |
The directory for the generated WAR. Default value is: ${project.build.directory} . |
warName | String |
- |
The name of the generated WAR. Default value is: ${project.build.finalName} . |
warSourceDirectory | File |
- |
Single directory for extra files to include in the WAR. This is
where you place your JSP files. Default value is: ${basedir}/src/main/webapp . |
webappDirectory | File |
- |
The directory where the webapp is built. Default value is: ${project.build.directory}/${project.build.finalName} . |
workDirectory | File |
- |
Directory to unpack dependent WARs into if needed. Default value is: ${project.build.directory}/war/work . |
Name | Type | Since | Description |
---|---|---|---|
archive | MavenArchiveConfiguration |
- |
The archive configuration to use. See Maven
Archiver Reference. |
archiveClasses | boolean |
2.0.1 |
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. Default value is: false . |
attachClasses | boolean |
2.1-alpha-2 |
Whether classes (that is the content of the WEB-INF/classes
directory) should be attached to the project. Default value is: false . |
classesClassifier | String |
2.1-alpha-2 |
The classifier to use for the attached classes artifact. Default value is: classes . |
classifier | String |
- |
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 | File |
- |
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 | String |
- |
Deprecated. Use <overlay>/<excludes> instead |
dependentWarIncludes | String |
- |
Deprecated. Use <overlay>/<includes> instead |
escapeString | String |
2.1-beta-1 |
Expression preceded with this String won't be interpolated.
\${foo} will be replaced with ${foo} . |
escapedBackslashesInFilePath | boolean |
2.1-alpha-2 |
To escape interpolated values with Windows path
c:\foo\bar will be replaced with
c:\\foo\\bar .Default value is: false . |
failOnMissingWebXml | boolean |
2.1-alpha-2 |
Whether or not to fail the build if the web.xml file
is missing. Set to false if you want you WAR built
without a web.xml file. This may be useful if you are
building an overlay that has no web.xml file.Default value is: true . |
filteringDeploymentDescriptors | boolean |
2.1-alpha-2 |
To filter deployment descriptors. Disabled by default. Default value is: false . |
filters | List |
- |
Filters (property files) to include during the interpolation of the
pom.xml. |
nonFilteredFileExtensions | List |
2.1-alpha-2 |
A list of file extensions that should not be filtered. Will be
used when filtering webResources and overlays. |
outputFileNameMapping | String |
2.1-alpha-1 |
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 | List |
2.1-alpha-1 |
The overlays to apply. |
packagingExcludes | String |
2.1-alpha-2 |
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 | String |
2.1-beta-1 |
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 |
- |
Whether this is the main artifact being built. Set to
false if you don't want to install or deploy it to the
local repository instead of the default one in an execution.Default value is: true . |
useCache | boolean |
2.1-alpha-1 |
Whether the cache should be used to save the status of the webapp
across multiple runs. Experimental feature so disabled by default. Default value is: false . |
warSourceExcludes | String |
- |
The comma separated list of tokens to exclude when copying the
content of the warSourceDirectory. |
warSourceIncludes | String |
- |
The comma separated list of tokens to include when copying the
content of the warSourceDirectory. Default value is: ** . |
webResources | Resource[] |
- |
The list of webResources we want to transfer. |
webXml | File |
- |
The path to the web.xml file to use. |
org.apache.maven.archiver.MavenArchiveConfiguration
No
boolean
2.0.1
No
${archiveClasses}
false
boolean
2.1-alpha-2
No
false
java.io.File
2.1-alpha-1
Yes
${project.build.directory}/war/work/webapp-cache.xml
java.lang.String
2.1-alpha-2
No
classes
java.lang.String
No
java.io.File
No
${maven.war.containerConfigXML}
java.lang.String
No
java.lang.String
No
\${foo}
will be replaced with ${foo}
.java.lang.String
2.1-beta-1
No
${maven.war.escapeString}
c:\foo\bar
will be replaced with
c:\\foo\\bar
.boolean
2.1-alpha-2
No
${maven.war.escapedBackslashesInFilePath}
false
web.xml
file
is missing. Set to false
if you want you WAR built
without a web.xml
file. This may be useful if you are
building an overlay that has no web.xml file.boolean
2.1-alpha-2
No
${failOnMissingWebXml}
true
filteringDeploymentDescriptors:
boolean
2.1-alpha-2
No
${maven.war.filteringDeploymentDescriptors}
false
java.util.List
No
java.util.List
2.1-alpha-2
No
java.lang.String
Yes
${project.build.directory}
java.lang.String
2.1-alpha-1
No
java.util.List
2.1-alpha-1
No
java.lang.String
2.1-alpha-2
No
java.lang.String
2.1-beta-1
No
false
if you don't want to install or deploy it to the
local repository instead of the default one in an execution.boolean
No
${primaryArtifact}
true
boolean
2.1-alpha-1
No
${useCache}
false
java.lang.String
Yes
${project.build.finalName}
java.io.File
Yes
${basedir}/src/main/webapp
java.lang.String
No
java.lang.String
No
**
org.apache.maven.model.Resource[]
No
java.io.File
No
${maven.war.webxml}
java.io.File
Yes
${project.build.directory}/${project.build.finalName}
java.io.File
Yes
${project.build.directory}/war/work