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+
pomVersion
3.0.0
true
String
3.
]]>
modelVersion
4.0.0
true
Declares to which version of project descriptor this POM conforms.
String
extend
3.0.0
project.xml file. For example,
<extend>${basedir}/../project.xml</extend>.
]]>
String
parent
4.0.0
The location of the parent project, if one exists. Values from the parent
project will be the default for this project if they are left unspecified. The location
is given as a group ID, artifact ID and version.
Parent
groupId
3.0.0+
true
org.apache.maven).
]]>
String
artifactId
3.0.0+
true
The identifier for this artifact that is unique within the group given by the
group ID. An artifact is something that is either produced or used by a project.
Examples of artifacts produced by Maven for a project include: JARs, source and binary
distributions, and WARs.
String
id
3.0.0
true
Deprecated. When used, this sets both the groupId
and artifactId elements if they were previously empty.
]]>
String
currentVersion
The current version of the artifact produced by this project.
3.0.0
true
String
version
4.0.0
true
The current version of the artifact produced by this project.
String
versions
3.0.0
Contains information on previous versions of the project.
Version
*
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
The full name of the project.
String
shortDescription
3.0.0
A short description of the project. The short description should be limited
to a single line.
String
description
3.0.0+
A detailed description of the project, used by Maven whenever it needs to
describe the project, such as on the web site. While this element can be specified as
CDATA to enable the use of HTML tags within the description, it is discouraged to allow
plain text representation. If you need to modify the index page of the generated web
site, you are able to specify your own instead of adjusting this text.
String
url
3.0.0+
String
siteAddress
3.0.0
The hostname of the web server that hosts the project's web site. This is
used when the web site is deployed.
String
siteDirectory
3.0.0
The directory on the web server where the public web site for this project
resides. This is used when the web site is deployed.
String
inceptionYear
3.0.0+
true
The year of the project's inception, specified with 4 digits. This value is
used when generating copyright notices as well as being informational.
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
organization
3.0.0+
This element describes various attributes of the organization to which the
project belongs. These attributes are utilized when documentation is created (for
copyright notices and links).
organisation
Organization
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
*
mailingLists
3.0.0+
Contains information about a project's mailing lists.
MailingList
*
developers
3.0.0+
Describes the committers of a project.
Developer
*
contributors
3.0.0+
Describes the contributors to a project that are not yet committers.
Contributor
*
issueTrackingUrl
3.0.0
The URL of the project's issue tracking system.
String
issueManagement
4.0.0
The project's issue management system information.
IssueManagement
branches
3.0.0
Branch
*
repository
3.0.0
Specification for the SCM used by the project, such as CVS, Subversion, etc.
Repository
scm
4.0.0
Specification for the SCM used by the project, such as CVS, Subversion, etc.
Scm
gumpRepositoryId
3.0.0
This is the repository identifier in Gump that this project is part of.
String
ciManagement
4.0.0
The project's continuous integration information.
CiManagement
distributionSite
3.0.0
maven.repo.central and maven.repo.central.directory.
]]>
String
distributionDirectory
3.0.0
The directory on the web server where the final distributions will be
published. This is used when the distributions are deployed.
String
packageGroups
3.0.0
Package groups required for complete javadocs.
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
*
properties
3.0.0
<name>value</name>.
]]>
Properties
String
*
packageName
3.0.0
String
The Java package name of the project. This value is used when generating
JavaDoc.
prerequisites
4.0.0
Describes the prerequisites in the build environment for this project.
Prerequisites
build
3.0.0+
true
Information required to build the project.
Build
profiles
4.0.0
A listing of project-local build profiles which will modify the build process
when activated.
Profile
*
3.0.0
4.0.0
groupId:artifactId:packaging:version
*/
public String getId()
{
StringBuffer id = new StringBuffer();
id.append( getGroupId() == null ? "[inherited]" : getGroupId() );
id.append( ":" );
id.append( getArtifactId() );
id.append( ":" );
id.append( getPackaging() );
id.append( ":" );
id.append( getVersion() == null ? "[inherited]" : getVersion() );
return id.toString();
}
@Override
public String toString()
{
return getId();
}
]]>
ModelBase
3.0.0+
Model and the Profile objects.
]]>
distributionManagement
4.0.0
Distribution information for a project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.
DistributionManagement
modules
4.0.0
The modules (sometimes called subprojects) to build as a part of this
project. Each module listed is a relative path to the directory containing the module.
String
*
repositories
4.0.0
The lists of the remote repositories for discovering dependencies and
extensions.
Repository
*
pluginRepositories
4.0.0
The lists of the remote repositories for discovering plugins for builds and
reports.
Repository
*
dependencies
3.0.0+
the
dependency mechanism for more information.
]]>
Dependency
*
reports
4.0.0
Deprecated. Now ignored by Maven.
]]>
DOM
reporting
4.0.0
mvn site.
All of the reports will be included in the navigation bar for browsing.
]]>
Reporting
dependencyManagement
4.0.0
false
Default dependency information for projects that inherit from this one. The
dependencies in this section are not immediately resolved. Instead, when a POM derived
from this one declares a dependency described by a matching groupId and artifactId, the
version and other values from this section are used for that dependency if they were not
already specified.
DependencyManagement
properties
4.0.0
<name>value</name>.
]]>
Properties
String
*
Branch
3.0.0
Contains information on the SCM branches of the project.
tag
3.0.0
true
The branch tag in the version control system (e.g. cvs) used by the project
for the source code associated with this branch of the project.
String
PluginContainer
3.0.0+
Contains the plugins informations for the project.
plugins
4.0.0
The list of plugins to use.
Plugin
*
4.0.0
pluginMap;
/**
* Reset the pluginsMap field to null
*/
public synchronized void flushPluginMap()
{
this.pluginMap = null;
}
/**
* @return a Map of plugins field with Plugins#getKey() as key
* @see org.apache.maven.model.Plugin#getKey()
*/
public synchronized java.util.Map getPluginsAsMap()
{
if ( pluginMap == null )
{
pluginMap = new java.util.LinkedHashMap();
if ( plugins != null )
{
for ( java.util.Iterator it = plugins.iterator(); it.hasNext(); )
{
Plugin plugin = (Plugin) it.next();
pluginMap.put( plugin.getKey(), plugin );
}
}
}
return pluginMap;
}
]]>
PluginConfiguration
3.0.0+
PluginContainer
Contains the plugins management informations for the project.
pluginManagement
4.0.0
false
Default plugin information to be made available for reference by projects
derived from this one. This plugin configuration will not be resolved or bound to the
lifecycle unless referenced. Any local configuration for a given plugin will override
the plugin's entire definition here.
PluginManagement
BuildBase
3.0.0+
PluginConfiguration
Generic informations for a build.
defaultGoal
3.0.0+
The default goal (or phase in Maven 2) to execute when none is specified for
the project.
String
resources
3.0.0+
This element describes all of the classpath resources such as properties
files associated with a project. These resources are often included in the final
package.
Resource
*
testResources
4.0.0
This element describes all of the classpath resources such as properties
files associated with a project's unit tests.
Resource
*
directory
4.0.0
The directory where all files generated by the build are placed.
String
finalName
4.0.0
${artifactId}-${version}.
]]>
String
filters
4.0.0
The list of filter properties files that are used when filtering is enabled.
String
*
Build
3.0.0+
BuildBase
<build> element contains informations required to build the project.
]]>
nagEmailAddress
3.0.0
An address to which notifications regarding the status of builds for this
project can be sent. This is intended for use by tools which do unattended builds, for
example those providing for continuous integration.
String
sourceDirectory
3.0.0+
true
This element specifies a directory containing the source of the project. The
generated build system will compile the source in this directory when the project is
built. The path given is relative to the project descriptor.
String
scriptSourceDirectory
4.0.0
true
This element specifies a directory containing the script sources of the
project. This directory is meant to be different from the sourceDirectory, in that its
contents will be copied to the output directory in most cases (since scripts are
interpreted rather than compiled).
String
unitTestSourceDirectory
3.0.0
true
This element specifies a directory containing the unit test source of the
project. The generated build system will compile these directories when the project is
being tested. The path given is relative to the project descriptor.
String
testSourceDirectory
4.0.0
true
This element specifies a directory containing the unit test source of the
project. The generated build system will compile these directories when the project is
being tested. The path given is relative to the project descriptor.
String
aspectSourceDirectory
3.0.0
This element specifies a directory containing Aspect sources of the project.
The generated build system will compile the Aspects in this directory when the project
is built if Aspects have been enabled. The path given is relative to the project
descriptor.
String
integrationUnitTestSourceDirectory
3.0.0
deprecated and should no longer be used.
Initially it was used by the first Cactus plugin. Now
the location of the Cactus test sources is defined
through a plugin property. See the Cactus plugin
properties
page.
]]>
String
sourceModifications
3.0.0
true
This element describes all of the sourceModifications associated with a
project. These modifications are used to exclude or include various source depending on
the environment the build is running in.
SourceModification
*
unitTest
3.0.0
true
This element specifies unit tests associated with the project.
new UnitTest()
UnitTest
outputDirectory
4.0.0
The directory where compiled application classes are placed.
String
testOutputDirectory
4.0.0
The directory where compiled test classes are placed.
String
extensions
4.0.0
A set of build extensions to use from this project.
Extension
*
CiManagement
4.0.0
<CiManagement> element contains informations required to the
continuous integration system of the project.
]]>
system
4.0.0
continuum.
]]>
String
url
4.0.0
URL for the continuous integration system used by the project if it has a web
interface.
String
notifiers
4.0.0
Configuration for notifying developers/users when a build is unsuccessful,
including user information and notification mode.
*
Notifier
Notifier
Configures one method for notifying users/developers when a build breaks.
4.0.0
type
4.0.0
mail
String
The mechanism used to deliver notifications.
sendOnError
4.0.0
true
boolean
Whether to send notifications on error.
sendOnFailure
4.0.0
true
boolean
Whether to send notifications on failure.
sendOnSuccess
4.0.0
true
boolean
Whether to send notifications on success.
sendOnWarning
4.0.0
true
boolean
Whether to send notifications on warning.
address
4.0.0
String
Deprecated. Where to send the notification to - eg email address.
]]>
configuration
Extended configuration specific to this notifier goes here.
Properties
String
*
Contributor
Description of a person who has contributed to the project, but who does not have
commit privileges. Usually, these contributions come in the form of patches submitted.
3.0.0+
name
3.0.0+
The full name of the contributor.
String
email
3.0.0+
The email address of the contributor.
String
url
3.0.0+
The URL for the homepage of the contributor.
String
organization
organisation
3.0.0+
The organization to which the contributor belongs.
String
organizationUrl
organisationUrl
3.0.0+
The URL of the organization.
String
roles
3.0.0+
role element, the body of which is a role name. This can also be used to
describe the contribution.
]]>
String
*
timezone
3.0.0+
The timezone the contributor is in. This is a number in the range -11 to 12.
String
properties
3.0.0+
Properties about the contributor, such as an instant messenger handle.
Properties
String
*
Dependency
3.0.0+
<dependency> element contains information about a dependency
of the project.
]]>
id
3.0.0
true
Deprecated. Please use 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
This url will be provided to the user if the jar file cannot be downloaded
from the central repository.
String
jar
3.0.0
Literal name of the artifact in the repository. Used to override the
calculated artifact name.
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
4.0.0
4.0.0
groupId:artifactId:type
*/
public String getManagementKey()
{
return groupId + ":" + artifactId + ":" + type + ( classifier != null ? ":" + classifier : "" );
}
]]>
3.0.0
id:type
*/
public String getKey()
{
return getId() + ":" + getType();
}
/**
* @return the groupId as artifact directory
*/
public String getArtifactDirectory()
{
return getGroupId();
}
/**
* @return the artifact name as artifactId-version.extension if <jar/> not set
*/
public String getArtifact()
{
// If the jar name has been explicty set then use that. This
// is when the 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 );
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
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() );
}
/**
* @see java.lang.Object#hashCode()
*/
public int hashCode()
{
return getId().hashCode();
}
]]>
Contributor
Developer
Information about one of the committers on this project.
3.0.0+
id
3.0.0+
The unique ID of the developer in the SCM.
String
Exclusion
4.0.0
<exclusion> element contains informations required to exclude
an artifact to the project.
]]>
artifactId
4.0.0
The artifact ID of the project to exclude.
String
true
groupId
4.0.0
The group ID of the project to exclude.
String
true
IssueManagement
Information about the issue tracking (or bug tracking) system used to manage this
project.
4.0.0
system
4.0.0
The name of the issue management system, e.g. Bugzilla
String
url
4.0.0
URL for the issue management system used by the project.
String
DistributionManagement
4.0.0
This elements describes all that pertains to distribution for a project. It is
primarily used for deployment of artifacts and the site produced by the build.
repository
4.0.0
Information needed to deploy the artifacts generated by the project to a
remote repository.
DeploymentRepository
snapshotRepository
4.0.0
repository element.
]]>
DeploymentRepository
site
Information needed for deploying the web site of the project.
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
Describes the licenses for this project. This is used to generate the license
page of the project's web site, as well as being taken into consideration in other reporting
and validation. The licenses listed for the project are that of the project itself, and not
of dependencies.
3.0.0+
name
3.0.0+
The full legal name of the license.
String
url
3.0.0+
The official url for the license text.
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+
This element describes all of the mailing lists associated with a project. The
auto-generated site references this information.
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+
The link to a URL where you can browse the mailing list archive.
String
otherArchives
3.0.0+
The link to alternate URLs where you can browse the list archive.
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+
The full name of the organization.
String
url
3.0.0+
The URL to the organization's home page.
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
The title to use for the package group.
String
packages
3.0.0
The packages in the group
String
PatternSet
3.0.0+
Definition of include or exclude patterns.
includes
3.0.0+
**/*.xml.
]]>
String
*
excludes
3.0.0+
**/*.xml
]]>
String
*
4.0.0
Parent
4.0.0
<parent> element contains informations required to the parent project.
]]>
artifactId
4.0.0
The artifact id of the parent project to inherit from.
true
String
groupId
4.0.0
The group id of the parent project to inherit from.
true
String
version
4.0.0
The version of the parent project to inherit.
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
groupId:artifactId:version
*/
public String getId()
{
StringBuffer id = new StringBuffer();
id.append( getGroupId() );
id.append( ":" );
id.append( getArtifactId() );
id.append( ":" );
id.append( "pom" );
// id.append( getPackaging() );
id.append( ":" );
id.append( getVersion() );
return id.toString();
}
]]>
Repository
3.0.0
<repository> element contains informations required to a repository
used by the project.
]]>
connection
3.0.0
URL format
and list of supported SCMs.
This connection is read-only.
]]>
String
developerConnection
3.0.0
connection, but for developers, i.e. this scm connection
will not be read only.
]]>
String
url
3.0.0
The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
String
Scm
4.0.0
<scm> element contains informations required to the SCM
(Source Control Management) of the project.
]]>
connection
4.0.0
URL format
and list of supported SCMs.
This connection is read-only.
]]>
String
developerConnection
4.0.0
connection, but for developers, i.e. this scm connection
will not be read only.
]]>
String
tag
4.0.0
The tag of current code. By default, it's set to HEAD during development.
String
HEAD
url
4.0.0
The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
String
FileSet
3.0.0+
PatternSet
A PatternSet for files.
directory
3.0.0+
Describe the directory where the resources are stored. The path is relative
to the POM.
String
4.0.0
Resource
This element describes all of the classpath resources associated with a project
or unit tests.
3.0.0+
FileSet
targetPath
3.0.0+
${project.build.outputDirectory}).
For example, if you want that resource to appear in a specific package
(org.apache.maven.messages), you must specify this
element with this value: org/apache/maven/messages.
This is not required if you simply put the resources in that directory
structure at the source, however.
]]>
String
filteringValue
3.0.0+
properties element and from the
properties in the files listed in the filters element.
]]>
String
mergeId
4.0.0+
String
4.0.0
SourceModification
This element describes all of the source modifications associated with a project.
These modifications are used to exclude or include various source depending on the
environment the build is running in.
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
A PatternSet for unit tests.
resources
3.0.0
The classpath resources to use when executing the unit tests.
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
The name given in the SCM (e.g. CVS) used by the project for the source code
associated with this version of the project.
String
id
3.0.0
A unique identifier for a version. This is usually identical to the name.
String
3.0.0
RepositoryBase
4.0.0
A repository contains the information needed for establishing connections with
remote repository.
id
4.0.0
true
settings.xml file, for example.
]]>
String
name
4.0.0
Human readable name of the repository.
String
url
4.0.0
true
protocol://hostname/path.
]]>
String
layout
4.0.0
legacy or default.
]]>
String
default
4.0.0
Repository
RepositoryBase
4.0.0
A repository contains the information needed for establishing connections with
remote repository.
releases
4.0.0
How to handle downloading of releases from this repository.
RepositoryPolicy
snapshots
4.0.0
How to handle downloading of snapshots from this repository.
RepositoryPolicy
4.0.0
DeploymentRepository
Repository
4.0.0
Repository contains the information needed for deploying to the remote
repository.
uniqueVersion
Whether to assign snapshots a unique version comprised of the timestamp and
build number, or to use the same version each time
boolean
true
4.0.0
4.0.0
RepositoryPolicy
4.0.0
Download policy.
enabledValue
4.0.0
Whether to use this repository for downloading this type of artifact.
String
updatePolicy
4.0.0
always,
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
4.0.0
Site
4.0.0
Contains the information needed for deploying websites.
id
4.0.0
settings.xml file, for example.
]]>
String
name
4.0.0
Human readable name of the deployment location.
String
url
4.0.0
protocol://hostname/path.
]]>
String
ConfigurationContainer
4.0.0
Contains the configuration information of the container like Plugin.
inherited
4.0.0
Whether any configuration should be propagated to child POMs.
String
The configuration as DOM object.
configuration
DOM
4.0.0
Plugin
4.0.0
ConfigurationContainer
<plugin> element contains informations required for a plugin.
]]>
groupId
The group ID of the plugin in the repository.
4.0.0
String
org.apache.maven.plugins
artifactId
The artifact ID of the plugin in the repository.
4.0.0
String
true
version
4.0.0
The version (or valid range of versions) of the plugin to be used.
String
extensions
4.0.0
boolean
Whether to load Maven extensions (such as packaging and type handlers) from
this plugin. For performance reasons, this should only be enabled when necessary.
false
executions
4.0.0
Multiple specifications of a set of goals to execute during the build
lifecycle, each having (possibly) a different configuration.
PluginExecution
*
dependencies
Additional dependencies that this project needs to introduce to the plugin's
classloader.
4.0.0
Dependency
*
goals
4.0.0
Deprecated. Unused by Maven.
]]>
DOM
4.0.0
executionMap = null;
/**
* Reset the executionMap field to null
*/
public void flushExecutionMap()
{
this.executionMap = null;
}
/**
* @return a Map of executions field with PluginExecution#getId() as key
* @see org.apache.maven.model.PluginExecution#getId()
*/
public java.util.Map getExecutionsAsMap()
{
if ( executionMap == null )
{
executionMap = new java.util.LinkedHashMap();
if ( getExecutions() != null )
{
for ( java.util.Iterator i = getExecutions().iterator(); i.hasNext(); )
{
PluginExecution exec = (PluginExecution) i.next();
if ( executionMap.containsKey( exec.getId() ) )
{
throw new IllegalStateException( "You cannot have two plugin executions with the same (or missing) elements.\nOffending execution\n\nId: \'" + exec.getId() + "\'\nPlugin:\'" + getKey() + "\'\n\n" );
}
executionMap.put( exec.getId(), exec );
}
}
}
return executionMap;
}
//TODO we shall reset key variable when groupId/artifactId change
private String key = null;
/**
* @return the key of the plugin, ie groupId:artifactId
*/
public String getKey()
{
if ( key == null )
{
key = constructKey( groupId, artifactId );
}
return key;
}
/**
* @param groupId
* @param artifactId
* @return the key of the plugin, ie groupId:artifactId
*/
public static String constructKey( String groupId, String artifactId )
{
return groupId + ":" + artifactId;
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
{
if ( other instanceof Plugin )
{
Plugin otherPlugin = (Plugin) other;
return getKey().equals( otherPlugin.getKey() );
}
return false;
}
/**
* @see java.lang.Object#hashCode()
*/
public int hashCode()
{
return getKey().hashCode();
}
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return "Plugin [" + getKey() + "]";
}
]]>
PluginExecution
4.0.0
ConfigurationContainer
<execution> element contains informations required for the
execution of a plugin.
]]>
id
4.0.0
String
default
The identifier of this execution for labelling the goals during the build,
and for matching executions 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 phase specified in their metadata.
goals
4.0.0
The goals to execute with the given configuration.
String
*
4.0.0
DependencyManagement
4.0.0
Section for management of default dependency information for use in a group of
POMs.
dependencies
4.0.0
The dependencies specified here are not used until they are referenced in a
POM within the group. This allows the specification of a "standard" version for a
particular dependency.
Dependency
*
PluginManagement
4.0.0
PluginContainer
Section for management of default plugin information for use in a group of POMs.
Reporting
4.0.0
Section for management of reports and their configuration.
excludeDefaults
4.0.0
boolean
If true, then the default reports are not included in the site generation.
This includes the reports in the "Project Info" menu.
false
outputDirectory
4.0.0
String
${project.build.directory}/site
.
]]>
plugins
4.0.0
The reporting plugins to use and their configuration.
ReportPlugin
*
4.0.0
reportPluginMap;
/**
* Reset the reportPluginMap field to null
*/
public synchronized void flushReportPluginMap()
{
this.reportPluginMap = null;
}
/**
* @return a Map of plugins field with ReportPlugin#getKey() as key
* @see org.apache.maven.model.ReportPlugin#getKey()
*/
public synchronized java.util.Map getReportPluginsAsMap()
{
if ( reportPluginMap == null )
{
reportPluginMap = new java.util.LinkedHashMap();
if ( getPlugins() != null )
{
for ( java.util.Iterator it = getPlugins().iterator(); it.hasNext(); )
{
ReportPlugin reportPlugin = (ReportPlugin) it.next();
reportPluginMap.put( reportPlugin.getKey(), reportPlugin );
}
}
}
return reportPluginMap;
}
]]>
Profile
ModelBase
4.0.0
Modifications to the build process which is activated based on environmental
parameters or command line arguments.
id
true
4.0.0
String
default
The identifier of this build profile. This used both for command line
activation, and identifies identical profiles to merge with during inheritance.
activation
4.0.0
The conditional logic which will automatically trigger the inclusion of this
profile.
Activation
build
4.0.0
true
Information required to build the project.
BuildBase
4.0.0
Activation
4.0.0
The conditions within the build runtime environment which will trigger the
automatic inclusion of the build profile.
activeByDefault
4.0.0
boolean
If set to true, this profile will be active unless another profile in this
pom is activated using the command line -P option or by one of that profile's
activators.
jdk
4.0.0
String
1.4 only activates on JDKs versioned 1.4,
while !1.4 matches any JDK that is not version 1.4.
]]>
os
4.0.0
Specifies that this profile will be activated when matching operating system
attributes are detected.
ActivationOS
property
4.0.0
Specifies that this profile will be activated when this system property is
specified.
ActivationProperty
file
4.0.0
Specifies that this profile will be activated based on existence of a file.
ActivationFile
ActivationProperty
4.0.0
This is the property specification used to activate a profile. If the value field
is empty, then the existence of the named property will activate the profile, otherwise it
does a case-sensitive match against the property value as well.
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
This is an activator which will detect an operating system's attributes in order
to activate its profile.
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
This is the file specification used to activate the profile. The missing value
will be the location of a file that needs to exist, and if it doesn't the profile will be
activated. On the other hand exists will test for the existence of the file and if it is
there the profile will be activated.
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
<plugin> element contains informations required for a report plugin.
]]>
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
The version of the reporting plugin to be used.
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
reportSetMap = null;
/**
* Reset the reportSetMap field to null
*/
public void flushReportSetMap()
{
this.reportSetMap = null;
}
/**
* @return a Map of reportSets field with ReportSet#getId() as key
* @see org.apache.maven.model.ReportSet#getId()
*/
public java.util.Map getReportSetsAsMap()
{
if ( reportSetMap == null )
{
reportSetMap = new java.util.LinkedHashMap();
if ( getReportSets() != null )
{
for ( java.util.Iterator i = getReportSets().iterator(); i.hasNext(); )
{
ReportSet reportSet = (ReportSet) i.next();
reportSetMap.put( reportSet.getId(), reportSet );
}
}
}
return reportSetMap;
}
/**
* @return the key of the report plugin, ie groupId:artifactId
*/
public String getKey()
{
return constructKey( groupId, artifactId );
}
/**
* @param groupId
* @param artifactId
* @return the key of the report plugin, ie groupId:artifactId
*/
public static String constructKey( String groupId, String artifactId )
{
return groupId + ":" + artifactId;
}
private boolean inheritanceApplied = true;
public void unsetInheritanceApplied()
{
this.inheritanceApplied = false;
}
public boolean isInheritanceApplied()
{
return inheritanceApplied;
}
]]>
ReportSet
4.0.0
Represents a set of reports and configuration to be used to generate them.
id
String
true
The unique id for this report set, to be used during POM inheritance.
default
configuration
4.0.0
Configuration of the report to be used when generating this set.
DOM
inherited
4.0.0
String
Whether any configuration should be propagated to child POMs.
reports
4.0.0
true
The list of reports from this plugin which should be generated from this set.
String
*
4.0.0
Prerequisites
4.0.0
Describes the prerequisites a project can have.
maven
4.0.0
String
2.0
The minimum version of Maven required to build the project, or to use this
plugin.
false
Relocation
4.0.0
Describes where an artifact has moved to. If any of the values are omitted, it is
assumed to be the same as it was before.
groupId
4.0.0
The group ID the artifact has moved to.
String
artifactId
4.0.0
The new artifact ID of the artifact.
String
version
4.0.0
The new version of the artifact.
String
message
4.0.0
An additional message to show the user about the move, such as the reason.
String
Extension
4.0.0
Describes a build extension to utilise.
groupId
4.0.0
The group ID of the extension's artifact.
true
String
artifactId
4.0.0
The artifact ID of the extension.
true
String
version
4.0.0
The version of the extension.
String
4.0.0