maven
Maven
This is a reference for the Maven project descriptor used in Maven.
An XSD is available at:
]]>
package
org.apache.maven.model
Model
ModelBase
<project> element is the root of the descriptor.
The following table lists all of the possible child elements.
]]>
3.0.0+
extend
3.0.0
project.xml file. For example,
<extend>${basedir}/../project.xml</extend>.
]]>
String
parent
4.0.0
Parent
modelVersion
4.0.0
true
String
pomVersion
3.0.0
true
String
3.]]>
groupId
3.0.0+
true
org.apache.maven).
]]>
String
artifactId
3.0.0+
true
String
id
3.0.0
true
Deprecated. When used, this sets both the groupId and artifactId elements
if they were previously empty.
]]>
String
packaging
4.0.0
jar
war
ear
pom.
Plugins can create their own packaging, and
therefore their own packaging types,
so this list does not contain all possible types.
]]>
String
jar
name
3.0.0+
true
String
currentVersion
3.0.0
true
String
version
4.0.0
true
String
shortDescription
3.0.0
String
description
3.0.0+
String
url
3.0.0+
String
logo
3.0.0
/images/project-logo.png) or an absolute URL
(e.g., http://my.corp/project-logo.png). This is used
when generating the project documentation.
]]>
String
prerequisites
4.0.0
Describes the prerequisites in the build environment for this project.
Prerequisites
issueTrackingUrl
3.0.0
String
issueManagement
4.0.0
IssueManagement
ciManagement
4.0.0
CiManagement
inceptionYear
3.0.0+
true
String
gumpRepositoryId
3.0.0
String
siteAddress
3.0.0
String
siteDirectory
3.0.0
String
distributionSite
3.0.0
maven.repo.central and maven.repo.central.directory.
]]>
String
distributionDirectory
3.0.0
String
mailingLists
3.0.0+
MailingList
*
developers
3.0.0+
Developer
*
contributors
3.0.0+
Contributor
*
licenses
3.0.0+
license element, which
is then described by additional elements.
Projects should only list the license(s) that applies to the project
and not the licenses that apply to dependencies.
If multiple licenses are listed, it is assumed that the user can select any of them, not that they
must accept all.
]]>
License
*
versions
3.0.0
Version
*
branches
3.0.0
Branch
*
packageGroups
3.0.0
PackageGroup
*
reports
3.0.0
maven site. All of the
reports will be included in the navigation bar for browsing in
the order they are specified.
]]>
String
*
scm
4.0.0
Scm
repository
3.0.0
Repository
organization
3.0.0+
organisation
Organization
properties
3.0.0
<name>value</name>.
]]>
Properties
String
*
packageName
3.0.0
String
build
3.0.0+
true
Build
profiles
4.0.0
Profile
*
3.0.0
groupId and
artifactId together instead.
]]>
String
groupId
3.0.0+
true
org.apache.maven.
]]>
String
artifactId
3.0.0+
true
maven-artifact.
]]>
String
version
3.0.0+
3.2.1. In Maven 2, this can also be
specified as a range of versions.
]]>
String
url
3.0.0
String
jar
3.0.0
String
type
3.0.0
jar. While it usually represents the extension on
the filename of the dependency, that is not always the case.
Some examples are jar, war, and plugin.
A dependency of type plugin is loaded as a Maven plugin and not added to the project
build classpath.
]]>
String
jar
type
4.0.0
jar. While it usually represents the extension on
the filename of the dependency, that is not always the case. A type can be mapped to a different
extension and a classifier.
The type often correspongs to the packaging used, though this is also not always the case.
Some examples are jar, war, ejb-client and test-jar.
New types can be defined by plugins that set
extensions to true, so this is not a complete list.
]]>
String
jar
classifier
4.0.0
jdk14 and jdk15.
]]>
String
false
properties
3.0.0
war.bundle property, and if found will include the
dependency in WEB-INF/lib.
]]>
Properties
String
*
scope
4.0.0
compile, runtime, test,
system, and provided. Used to
calculate the various classpaths used for compilation, testing, and so on. It also assists in determining
which artifacts to include in a distribution of this project. For more information, see
the
dependency mechanism.]]>
String
systemPath
4.0.0
discouraged and may be replaced in later
versions. This specifies the path on the filesystem for this dependency.
Requires an absolute path for the value, not relative.
Use a property that gives the machine specific absolute path,
e.g. ${java.home}.
]]>
String
exclusions
4.0.0
Lists a set of artifacts that should be excluded from this dependency's artifact list when it comes to
calculating transitive dependencies.
Exclusion
*
optional
4.0.0
Indicates the dependency is optional for use of this library. While the version of the dependency will be
taken into account for dependency calculation if the library is used elsewhere, it will not be passed on
transitively.
boolean
false
3.0.0
element is explicity used in the POM.
if ( getJar() != null)
{
return getJar();
}
String artifact;
if ("ejb-client".equals(getType())) {
artifact = getArtifactId() + "-" + getVersion() + "-client." + getExtension();
} else {
artifact = getArtifactId() + "-" + getVersion() + "." + getExtension();
}
return artifact;
}
public String getTypeDirectory()
{
String path;
if (getType().equals("ejb-client")) {
path = "ejbs";
} else {
path = getType() + "s";
}
return path;
}
public String getExtension()
{
if ("ejb".equals(getType()) || "ejb-client".equals(getType()) || "plugin".equals(getType()) || "aspect".equals(getType()) || "uberjar".equals(getType())) return "jar";
return getType();
}
public boolean isAddedToClasspath()
{
return ("jar".equals(getType()) || "ejb".equals(getType()) || "ejb-client".equals(getType()) || "sar".equals(getType()));
}
public boolean isPlugin()
{
return ("plugin".equals(getType()));
}
public String getProperty( String property )
{
return getProperties().getProperty( property );
}
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( !( o instanceof Dependency ) )
{
return false;
}
Dependency d = (Dependency) o;
return getId().equals( d.getId() );
}
public int hashCode()
{
return getId().hashCode();
}
]]>
Contributor
Developer
3.0.0+
id
3.0.0+
String
Exclusion
4.0.0
artifactId
4.0.0
String
true
groupId
4.0.0
String
true
IssueManagement
Information about the issue tracking (or bug tracking) system used to manage this project.
4.0.0
system
4.0.0
String
url
4.0.0
String
DistributionManagement
4.0.0
repository
4.0.0
DeploymentRepository
snapshotRepository
4.0.0
repository element.
]]>
DeploymentRepository
site
4.0.0
Site
downloadUrl
4.0.0+
url. This is given to assist in locating artifacts that are not in the repository due to
licensing restrictions.
]]>
String
relocation
4.0.0
Relocation information of the artifact if it has been moved to a new group ID and/or artifact ID.
Relocation
status
4.0.0
none (default),
converted (repository manager converted this from an Maven 1 POM), partner
(directly synced from a partner Maven 2 repository), deployed (was deployed from a Maven 2
instance), verified (has been hand verified as correct and final).
]]>
false
String
License
3.0.0+
name
3.0.0+
String
url
3.0.0+
String
distribution
3.0.0+
repo
may be downloaded from the Maven repository
manual
user must manually download and install the dependency.
]]>
String
comments
Addendum information pertaining to this license.
3.0.0+
String
MailingList
3.0.0+
name
3.0.0+
String
subscribe
3.0.0+
mailto: link will automatically be created when
the documentation is created.
]]>
String
unsubscribe
3.0.0+
mailto: link will automatically be created
when the documentation is created.
]]>
String
post
3.0.0+
mailto: link will automatically be created
when the documentation is created.
]]>
String
archive
3.0.0+
String
otherArchives
3.0.0+
String
*
We could probably have a specific element for a dev mailing list for
things like CI, and maybe even a specific element for the user and scm
mailing lists. Then leave the more lose structure for any other type
of mailing list.
Organization
Specifies the organization that produces this project.
3.0.0+
name
3.0.0+
String
url
3.0.0+
String
logo
3.0.0
/images/org-logo.png) or an absolute URL
(e.g., http://my.corp/logo.png). This value is used
when generating the project documentation.
]]>
String
PackageGroup
3.0.0
A JavaDoc package group.
title
3.0.0
String
packages
3.0.0
String
PatternSet
3.0.0+
includes
3.0.0+
**/*.xml.]]>
String
*
excludes
3.0.0+
**/*.xml]]>
String
*
Parent
4.0.0
artifactId
4.0.0
true
String
groupId
4.0.0
true
String
version
4.0.0
String
relativePath
4.0.0
pom.xml file within the check out.
The default value is ../pom.xml.
Maven looks for the parent pom first in the reactor of currently building projects, then in this location on
the filesystem, then the local repository, and lastly in the remote repo.
relativePath allows you to select a different location,
for example when your structure is flat, or deeper without an intermediate parent pom.
However, the group ID, artifact ID and version are still required,
and must match the file in the location given or it will revert to the repository for the POM.
This feature is only for enhancing the development in a local checkout of that project.
]]>
String
../pom.xml
4.0.0
org/apache/maven/messages.
This is not required if you simply put the resources in that directory structure at the source, however.
]]>
String
filtering
3.0.0+
properties element and from the properties in the files listed
in the filters element.
]]>
boolean
false
SourceModification
3.0.0
FileSet
className
3.0.0
not be
loaded, then the includes and excludes specified below
will be applied to the contents of the sourceDirectory.
]]>
String
property
3.0.0
not set,
then the includes and excludes specified below
will be applied to the contents of the sourceDirectory.
]]>
String
UnitTest
3.0.0
PatternSet
resources
3.0.0
Resource
*
Version
3.0.0
version
element
]]>
name
3.0.0
1.0,
1.1-alpha1,
1.2-beta,
1.3.2 etc.
]]>
String
tag
3.0.0
String
id
3.0.0
builds.
]]>
String
3.0.0
default.
]]>
String
default
4.0.0
daily
(default),
interval:XXX
(in minutes) or
never
(only if it doesn't exist locally).
]]>
String
checksumPolicy
4.0.0
ignore
,
fail
or
warn
(the default).
]]>
String
Site
4.0.0
id
4.0.0
settings.xml file, for example.
]]>
String
name
4.0.0
String
url
4.0.0
protocol://hostname/path.
]]>
String
ConfigurationContainer
4.0.0
inherited
4.0.0
String
configuration
DOM
4.0.0
elements.\nOffending execution\n\nId: \'" + exec.getId() + "\'\nPlugin:\'" + getKey() + "\'\n\n" );
}
executionMap.put( exec.getId(), exec );
}
}
}
return executionMap;
}
public String getKey()
{
return constructKey( groupId, artifactId );
}
public static String constructKey( String groupId, String artifactId )
{
return groupId + ":" + artifactId;
}
]]>
PluginExecution
4.0.0
ConfigurationContainer
id
4.0.0
true
String
default
The identifier of this execution for labelling the goals during the build, and for matching
exections to merge during inheritance.
phase
4.0.0
String
The build lifecycle phase to bind the goals in this execution to. If omitted, the goals will
be bound to the default specified in their metadata.
goals
4.0.0
The goals to execute with the given configuration.
String
*
4.0.0
!1.4 matches any JDK that is not version 1.4.
]]>
os
4.0.0
ActivationOS
property
4.0.0
ActivationProperty
file
4.0.0
ActivationFile
ActivationProperty
4.0.0
name
4.0.0
String
true
The name of the property to be used to activate a profile.
value
4.0.0
String
The value of the property required to activate a profile.
ActivationOS
4.0.0
name
4.0.0
String
${os.name} Java property, such as Windows XP.]]>
family
4.0.0
String
windows or unix.]]>
arch
4.0.0
String
The architecture of the operating system to be used to activate the profile.
version
4.0.0
String
The version of the operating system to be used to activate the profile.
ActivationFile
4.0.0
missing
4.0.0
String
The name of the file that must be missing to activate the profile.
exists
4.0.0
String
The name of the file that must exist to activate the profile.
ReportPlugin
4.0.0
groupId
4.0.0
String
true
org.apache.maven.plugins
The group ID of the reporting plugin in the repository.
artifactId
4.0.0
String
true
The artifact ID of the reporting plugin in the repository.
version
4.0.0
String
inherited
4.0.0
String
Whether the configuration in this plugin should be made available to projects that
inherit from this one.
configuration
4.0.0
DOM
The configuration of the reporting plugin.
reportSets
4.0.0
execution in the build.]]>
ReportSet
*
4.0.0