Maven Plugins
org.apache.maven.plugins
maven-assembly-plugin
2.2-beta-1-SNAPSHOT
assembly
false
true
attached
Assemble an application bundle or distribution from an assembly descriptor.
Do not specify a phase, so make it usable in a reactor environment where forking would create issues.
false
true
false
true
false
true
org.apache.maven.plugin.assembly.mojos.AttachedAssemblyMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
project
org.apache.maven.project.MavenProject
true
false
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader
assembly
Assemble an application bundle or distribution from an assembly descriptor.
false
true
false
true
false
true
package
org.apache.maven.plugin.assembly.mojos.AssemblyMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
executedProject
org.apache.maven.project.MavenProject
false
true
Get the executed project from the forked lifecycle.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${executedProject}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader
single
Assemble an application bundle or distribution from an assembly descriptor.
Do not specify a phase, so make it usable in a reactor environment where forking would create issues.
Do not specify it as an aggregator, so it is only for a single project.
Both cases aid it in working around issues with the Maven lifecycle that should be addressed in Maven 2.1.
false
true
false
false
false
true
org.apache.maven.plugin.assembly.mojos.SingleAssemblyMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
project
org.apache.maven.project.MavenProject
true
false
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader
unpack
Unpack project dependencies. Currently supports dependencies of type jar and zip.
test
false
true
false
false
false
true
org.apache.maven.plugin.assembly.mojos.UnpackMojo
java
per-lookup
once-per-session
project
org.apache.maven.project.MavenProject
true
false
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${project.build.directory}/assembly/work
org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
directory-inline
Assemble an application bundle or distribution from an assembly descriptor without
launching a parallel lifecycle build.
false
true
false
true
false
true
org.apache.maven.plugin.assembly.mojos.DirectoryInlineMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
project
org.apache.maven.project.MavenProject
true
false
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader
directory
Assemble an application bundle or distribution.
false
true
false
true
false
true
package
org.apache.maven.plugin.assembly.mojos.DirectoryMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
executedProject
org.apache.maven.project.MavenProject
false
true
Get the executed project from the forked lifecycle.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${executedProject}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader
directory-single
Assemble an application bundle or distribution from an assembly descriptor without
launching a parallel lifecycle build. Also, this mojo is not an aggregator, so it can be used
multiple times in a single multimodule build.
false
true
false
false
false
true
org.apache.maven.plugin.assembly.mojos.DirectorySingleMojo
java
per-lookup
once-per-session
appendAssemblyId
boolean
false
true
Set to false to exclude the assembly id from the assembly final name.
archive
org.apache.maven.archiver.MavenArchiveConfiguration
false
true
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to
specify a Manifest file for the jar, in addition to other options.
archiveBaseDirectory
java.io.File
false
true
This is the base directory from which archive files are created.
This base directory pre-pended to any <code><directory></code>
specifications in the assembly descriptor. This is an optional
parameter
attach
boolean
false
true
basedir
java.io.File
true
false
Base directory of the project.
classifier
java.lang.String
Please use the Assembly's id for classifier instead
false
true
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the
assembly-id instead of specifying this here.
descriptor
java.io.File
Please use descriptors instead
false
true
Assembly XML Descriptor file. This must be the path to your customized descriptor file.
descriptorId
java.lang.String
Please use descriptorRefs instead
false
true
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
descriptorRefs
java.lang.String[]
false
true
A list of built-in descriptor references to generate from. You can select from <code>bin</code>,
<code>jar-with-dependencies</code>, or <code>src</code>.
descriptorSourceDirectory
java.io.File
false
true
directory to scan for descriptor files in
descriptors
java.io.File[]
false
true
A list of descriptor files to generate from.
filters
java.util.List
false
false
finalName
java.lang.String
true
true
The filename of the assembled distribution file.
includeSite
boolean
Please set this variable in the assembly descriptor instead
false
true
Set to true to include the site generated by site:site goal.
localRepository
org.apache.maven.artifact.repository.ArtifactRepository
true
false
Local Maven repository where artifacts are cached during the build process.
outputDirectory
java.io.File
true
true
The output directory of the assembled distribution file.
project
org.apache.maven.project.MavenProject
true
false
reactorProjects
java.util.List
true
false
Contains the full list of projects in the reactor.
remoteRepositories
java.util.List
true
false
siteDirectory
java.io.File
false
false
Directory for site generated.
tarLongFileMode
java.lang.String
false
true
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
tempRoot
java.io.File
true
false
Temporary directory that contain the files to be assembled.
workDirectory
java.io.File
true
true
Directory to unpack JARs into if needed
${includeSite}
${classifier}
${attach}
${tarLongFileMode}
${descriptorId}
${descriptor}
${appendAssemblyId}
org.apache.maven.plugin.assembly.archive.AssemblyArchiver
assemblyArchiver
org.apache.maven.project.MavenProjectHelper
projectHelper
org.apache.maven.plugin.assembly.io.AssemblyReader
assemblyReader