Apache Maven Archiver

The Maven Archiver is mainly used by plugins to handle packaging. The
version numbers referenced in the Since column on this page are the
version of the Maven Archiver component - not for any specific plugin.
To see which version of Maven Archiver a plugin uses, go to the site
for that plugin.

archive

The pom file, located in the archive in
META-INF/maven/${groupId}/${artifactId}/pom.xml

A pom.properties file,
located in the archive in META-INF/maven/${groupId}/${artifactId}/pom.properties

The default value is true.

boolean

compress

Activate compression for the archive.
The default value is true.

boolean

forced

Whether recreating the archive is forced (default) or not. Setting
this option to false, means that the archiver should compare the
timestamps of included files with the timestamp of the target archive
and rebuild the archive, only if the latter timestamp precedes the
former timestamps. Checking for timestamps will typically offer a
performance gain (in particular, if the following steps in a build
can be suppressed, if an archive isn't recrated) on the cost that
you get inaccurate results from time to time. In particular, removal
of source files won't be detected.

An archiver doesn't necessarily support checks for uptodate. If
so, setting this option to true will simply be ignored.

The default value is true.

boolean

2.2

index

Whether the created archive will contain an
INDEX.LIST file.
The default value is false.

Whether to create an Extension-List manifest
entry.
The default value is false.

boolean

classpathLayoutType

The type of layout to use when formatting entries in the created
Class-Path. Valid values are: simple,
repository (the same as a Maven classpath layout) and
custom.
Note: If you specify a type of custom you
must also set customClasspathLayout.
The default value is simple.

String

2.4

classpathMavenRepositoryLayout

The created Class-Path entry will contain paths
that follow the Maven 2 repository layout:
${groupId}/${artifactId}/${version}/${fileName}.
The default value is false.

boolean

2.3

classpathPrefix

A text that will be prefixed to all your Class-Path
entries.
The default value is "".

String

customClasspathLayout

The layout expression to use when the layout type set in
classpathLayoutType has the value custom.
Expressions will be evaluated against the following ordered list
of classpath-related objects:

The current Artifact instance, if one exists.

The current ArtifactHandler instance from the artifact above.

Note: If you specify a layout type of custom
you must set this layout expression.

String

2.4

mainClass

The Main-Class manifest entry.

String

packageName

Package manifest entry.

String

useUniqueVersions

Whether to use unique timestamp Snapshot versions rather than -SNAPSHOT versions.
The default value is true.

boolean

2.4

manifestSection

Element

Description

Type

Since

name

The name of the section.

String

manifestEntries

A list of key/value pairs to add to the manifest.

Map

pom.properties content

The auto created pom.properties file will contain the
following content: