war:exploded

Full name:

org.apache.maven.plugins:maven-war-plugin:2.1-alpha-2:exploded

Description:

Generate the exploded webapp

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
cacheFile File 2.1 The file containing the webapp structure cache.
warSourceDirectory File - Single directory for extra files to include in the WAR.
webappDirectory File - The directory where the webapp is built.
workDirectory File - Directory to unpack dependent WARs into if needed

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The archive configuration to use. See Maven Archiver Reference.
archiveClasses boolean - Whether a JAR file will be created for the classes in the webapp. Using this optional configuration parameter will make the generated classes to be archived into a jar file and the classes directory will then be excluded from the webapp. Default value is: false.
containerConfigXML File - The path to the context.xml file to use.
dependentWarExcludes String - Deprecated. use the excludes in the overlay object instead
dependentWarIncludes String - Deprecated. use the includes in the overlay object instead
escapedBackslashesInFilePath boolean 2.1-alpha-2 To escape interpolated value with windows path c:\foo\bar will be replace with c\:\\foo\\bar Default value is: false.
filteringDeploymentDescriptors boolean 2.1-alpha-2 To filtering 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 to not filtering. will be used for webResources and overlay filtering
outputFileNameMapping String 2.0.3 The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.
overlays List 2.1 The overlays to apply.
useCache boolean 2.1 Whether the cache should be used to save the status of the webapp accross multiple runs. Default value is: true.
warSourceExcludes String - The comma separated list of tokens to exclude when copying content of the warSourceDirectory.
warSourceIncludes String - The comma separated list of tokens to include when copying content of the warSourceDirectory. Default is '**'.
webResources Resource[] - The list of webResources we want to transfer.
webXml File - The path to the web.xml file to use.

Parameter Details

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

archiveClasses:

Whether a JAR file will be created for the classes in the webapp. Using this optional configuration parameter will make the generated classes to be archived into a jar file and the classes directory will then be excluded from the webapp.
  • Type: boolean
  • Required: No
  • Expression: ${archiveClasses}
  • Default: false

cacheFile:

The file containing the webapp structure cache.
  • Type: java.io.File
  • Since: 2.1
  • Required: Yes
  • Expression: ${project.build.directory}/war/work/webapp-cache.xml

containerConfigXML:

The path to the context.xml file to use.
  • Type: java.io.File
  • Required: No
  • Expression: ${maven.war.containerConfigXML}

dependentWarExcludes:

Deprecated. use the excludes in the overlay object instead
The comma separated list of tokens to exclude when doing a war overlay.
  • Type: java.lang.String
  • Required: No

dependentWarIncludes:

Deprecated. use the includes in the overlay object instead
The comma separated list of tokens to include when doing a war overlay. Default is '**'
  • Type: java.lang.String
  • Required: No

escapedBackslashesInFilePath:

To escape interpolated value with windows path c:\foo\bar will be replace with c\:\\foo\\bar
  • Type: boolean
  • Since: 2.1-alpha-2
  • Required: No
  • Expression: ${maven.war.escapedBackslashesInFilePath}
  • Default: false

filteringDeploymentDescriptors:

To filtering deployment descriptors disabled by default
  • Type: boolean
  • Since: 2.1-alpha-2
  • Required: No
  • Expression: ${maven.war.filteringDeploymentDescriptors}
  • Default: false

filters:

Filters (property files) to include during the interpolation of the pom.xml.
  • Type: java.util.List
  • Required: No

nonFilteredFileExtensions:

A list of file extensions to not filtering. will be used for webResources and overlay filtering
  • Type: java.util.List
  • Since: 2.1-alpha-2
  • Required: No

outputFileNameMapping:

The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.
  • Type: java.lang.String
  • Since: 2.0.3
  • Required: No

overlays:

The overlays to apply.
  • Type: java.util.List
  • Since: 2.1
  • Required: No

useCache:

Whether the cache should be used to save the status of the webapp accross multiple runs.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${useCache}
  • Default: true

warSourceDirectory:

Single directory for extra files to include in the WAR.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/webapp

warSourceExcludes:

The comma separated list of tokens to exclude when copying content of the warSourceDirectory.
  • Type: java.lang.String
  • Required: No

warSourceIncludes:

The comma separated list of tokens to include when copying content of the warSourceDirectory. Default is '**'.
  • Type: java.lang.String
  • Required: No

webResources:

The list of webResources we want to transfer.
  • Type: org.apache.maven.model.Resource[]
  • Required: No

webXml:

The path to the web.xml file to use.
  • Type: java.io.File
  • Required: No
  • Expression: ${maven.war.webxml}

webappDirectory:

The directory where the webapp is built.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}

workDirectory:

Directory to unpack dependent WARs into if needed
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/war/work