All Classes and Interfaces
Class
Description
Deprecated.
Deprecated.
Base class for artifact resolution exceptions.
A skeleton eventspy that does nothing other than helping implementors.
Provides a skeleton implementation for execution listeners.
Base lifecycle mapping provider, ie per-packaging plugin bindings for
default lifecycle.Base lifecycle provider.
Allows core extensions to participate in Maven build session lifecycle.
AbstractMavenTransferListener
Provides a skeleton implementation for model building listeners.
Abstract class to provide most of the infrastructure required to implement a
The implementation should have a
Mojo except for
the execute method.The implementation should have a
Mojo annotation with the name of the goal:Base exception.
Deprecated.
Use a regular expression search to find and resolve expressions within the POM.
Deprecated.
Deprecated.
The conditions within the build runtime environment which will trigger the
automatic inclusion of the build profile.
The conditions within the build runtime environment which will trigger
the automatic inclusion of the parent build profile.
The conditions within the build runtime environment
which will trigger
the automatic inclusion of the parent build profile.
Builder class used to create Activation instances.
Builder class used to create Activation instances.
This is the file specification used to activate the profile.
This is the file specification used to activate a profile.
This is the file specification used to activate a
profile.
Builder class used to create ActivationFile instances.
Builder class used to create ActivationFile instances.
This is an activator which will detect an operating system's attributes in order
to activate its profile.
This is an activator which will detect an operating system's attributes in order to activate
its profile.
This is an activator which will detect an operating
system's attributes in order to activate
its profile.
Builder class used to create ActivationOS instances.
Builder class used to create ActivationOS instances.
This is the property specification used to activate a profile.
This is the property specification used to activate a profile.
This is the property specification used to activate a
profile.
Builder class used to create ActivationProperty instances.
Builder class used to create ActivationProperty instances.
Deprecated.
Apply multiple filters.
Provides a fluent API for generating
ANSI escape sequences.
Display attributes, also know as
SGR
(Select Graphic Rendition) parameters.
ANSI 8 colors for fluent API
ED (Erase in Display) / EL (Erase in Line) parameter (see
CSI sequence J and K)
An artifact points to a resource such as a jar file or war application.
Maven Artifact interface.
Deprecated.
The
Coordinate object is used to point to an Artifact
but the version may be specified as a range instead of an exact version.Service used to create
ArtifactCoordinate objects.A request for creating a
ArtifactCoordinate object.Deploys
Artifacts to a RemoteRepository.Deprecated.
An artifact could not correctly being deployed.
A request for deploying one or more artifacts to a remote repository.
Deprecated.
Populates Aether
ArtifactDescriptorResult from Maven project Model.Warning: This is an internal utility class that is only public for technical reasons, it is not part
of the public API.
Deprecated.
Service used to create
Artifact objects.Deprecated.
Deprecated.
Deprecated.
An artifact handler contains information explaining how an artifact plugs into the Maven build:
Information needed to find the artifact file in a repository including extension and classifier
Information on how to use the artifact as a dependency: whether to add it to the classpath, whether to load its
dependencies transitively
Deprecated.
Installs
Artifacts to the local repository.Deprecated.
A request for installing one or more artifacts in the local repository.
Deprecated.
Contains metadata about an artifact, and methods to retrieve/store it from an artifact repository.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Represents a model pulled from a repository
Deprecated.
Avoid use of this type, if you need access to local repository use repository system classes instead.
Deprecated.
Deprecated.
Deprecated.
Avoid use of this type, if you need access to local repository use repository system session instead.
ArtifactRepositoryLayout2
Deprecated.
Deprecated.
Avoid use of this type, if you need access to local repository use repository system session instead.
Deprecated.
Deprecated.
Resolves the artifact, i.e download the file when required and attach it to the artifact
Deprecated.
A request for resolving an artifact.
The Artifact Result
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
ArtifactUtils
Describes an artifact version in terms of its components, converts it to/from a string and
compares two versions.
ArtifactWithDependencies
Deprecated.
Authentication
A path translator that resolves relative paths against a specific base directory.
Abstract implementation.
Thrown when a bean couldn't be configured.
Postprocesses filesystem paths.
A request to configure a bean from some configuration in the POM or similar.
Preprocesses a value from a bean configuration before the bean configurator unmarshals it into a bean property.
Unmarshals some textual configuration from the POM or similar into the properties of a bean.
bom packaging plugins bindings provider for default lifecycle.BootstrapCoreExtensionManager
The
<build> element contains information required to build the project.Builder class used to create Build instances.
A special throwable used to signal a graceful abort of the build.
Build configuration in a profile.
Builder class used to create BuildBase instances.
A
Builder encapsulates a strategy for building a set of Maven projects.Common code that is shared by the LifecycleModuleBuilder and the LifeCycleWeaveBuilder
BuilderNotFoundException
Describes a problem that was encountered during project building.
The different severity levels for a problem, in decreasing order.
Summarizes the result of a failed project build in the reactor.
One or more builds failed.
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
Instances of this class are responsible for determining whether it makes sense to "resume" a build (i.e., using
the
--resume flag.This class holds the information required to enable resuming a Maven build with
--resume.Instances of this interface retrieve and store data for the --resume / -r feature.
This exception will be thrown when something fails while persisting build resumption data.
Summarizes the result of a successful project build in the reactor.
Summarizes the result of a project build in the reactor.
Simple
ThreadFactory implementation that ensures the corresponding threads have a meaningful name.Deprecated.
Checksum algorithms service.
The checksum algorithm.
The checksum calculator.
Deprecated.
The
<ciManagement> element contains information required to the
continuous integration system of the project.Builder class used to create CiManagement instances.
Deprecated.
Deprecated.
Describes a constituent of a class realm.
Manages the class realms used by Maven.
ClassRealmManagerDelegate is used to perform addition configuration of
class realms created by ClassRealmManager.
Describes the requirements for a new class realm.
The type of a class realm.
CleanArgument
clean lifecycle provider.Utility class used to report errors, statistics, application version info, etc.
CliRequest
Generic implementation of version comparison.
Presents a view of the Dependency Graph that is suited for concurrent building.
Contains the configuration information of the container like Plugin.
Builder class used to create ConfigurationContainer instances.
ConfigurationProcessor
Deprecated.
Deprecated.
Deprecated.
Console download progress meter.
A type implemented by, or extended by maven plugins or extensions.
Consumer POM transformer.
Interface to allow
The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo.
Mojos to communicate with each others Mojos, other than
project's source root and project's attachment.The plugin manager would pull the context out of the plugin container context, and populate it into the Mojo.
Description of a person who has contributed to the project, but who does not have
commit privileges.
Builder class used to create Contributor instances.
Provides information about artifacts (identified by groupId:artifactId string key) and classpath elements exported by
Maven core itself and loaded Maven core extensions.
CoreExportsProvider
Describes a build extension to utilise.
Builder class used to create CoreExtension instances.
Provides information about artifacts (identified by groupId:artifactId string key) and classpath elements exported by
Maven core itself or a Maven core extension.
Extensions to load.
Builder class used to create CoreExtensions instances.
Access to core
ClassRealm.Filter to only retain objects in the given scope or better.
Exception occurring trying to resolve a plugin.
Indicates a cycle in the dependency graph.
Deprecated.
Deprecated.
A wrapper class around a maven resolver artifact.
Deprecated.
A wrapper class around a maven resolver artifact.
Deprecated.
Implementation of
ArtifactDeployer service.Default artifact descriptor reader.
DefaultArtifactFactory
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Default implementation of artifact versioning.
A basic bean configuration request.
Warning: This is an internal class that is only public for technical reasons, it is not part of the
public API.
DefaultBuildPluginManager
Default implementation of
BuildResumptionAnalyzer.This implementation of
BuildResumptionDataRepository persists information in a properties file.Deprecated.
Manages the class realms used by Maven.
Deprecated.
As of 3.0, use a specific implementation instead, e.g.
Deprecated.
Handles the import of dependency management from other models into the target model.
Handles injection of dependency management into the model.
ManagementModelMerger
DefaultEventSpyContext
Transform an exception into useful end-user message.
Assists in firing execution events.
Default extension realm cache implementation.
CacheKey
Builds the
inter-dependencies graph between projects in the reactor.Deprecated.
Deprecated.
Handles inheritance of model values.
InheritanceModelMerger
Deprecated.
clients that do not require compatibility with Maven 3.2.3 and earlier should link to
JavaToolchainImpl instead.Deprecated.
Helps to provide backward-compatibility with plugins that use legacy components.
Handles injection of plugin executions induced by the lifecycle bindings for a packaging.
The domain-specific model merger for lifecycle bindings
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
A facade that provides lifecycle services to components outside maven core.
DefaultLifecycleMapping
Lifecycle mapping delegate component interface.
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
default lifecycle provider.Starts the build life cycle
Calculates the task segments in the build
Assists in populating an execution request for invocation of Maven.
Deprecated.
CacheKey
Provides basic services to manage Maven plugins and their mojos.
Deprecated.
DefaultMavenProjectHelper
Deprecated.
Handles deserialization of metadata from some kind of textual format like XML.
Deprecated.
Deprecated.
DefaultMirrorSelector
A factory to create model builder instances when no dependency injection is available.
Processes events from the model builder while building the effective model for a
MavenProject instance.Collects settings that control building of effective models.
A model builder cache backed by the repository system cache.
Default implementation of
ModelCacheFactory.Deprecated.
Locates a POM file within a project base directory.
Handles normalization of a model.
DuplicateMerger
Resolves relative paths within a model against a specific base directory.
Describes a problem that was encountered during model building.
Note: uses @Typed to limit the types it is available for injection to just ModelProcessor.
Handles deserialization of a model from some kind of textual format like XML.
Normalizes URLs to remove the ugly parent references "../" that got potentially inserted by URL adjustment during
model inheritance.
Deprecated.
Maven default implementation of the
ModelVersionProcessor to support
CI Friendly VersionsHandles serialization of a model into some kind of textual format like XML.
Default mojo execution strategy.
TODO: this is session scoped as SPI can contribute.
Resolves relative paths against a specific base directory.
Deprecated.
CacheKey
Handles expansion of general build plugin configuration into individual executions.
Assists in resolving the dependencies of a plugin.
Caches raw plugin descriptors.
Handles injection of plugin management into the model.
ManagementModelMerger
Deprecated.
Collects settings required to resolve a plugin prefix.
Resolves a plugin prefix.
Default PluginCache implementation.
CacheKey
Collects settings required to resolve the version for a plugin.
Resolves a version for a plugin.
Describes the environmental context used to determine the activation status of profiles.
Handles profile injection into the model.
ProfileModelMerger
Deprecated.
Calculates the active profiles among a given collection of profiles.
Default component responsible for creation of MavenProject#dependencyArtifacts instances.
CacheKey
DefaultProjectBuilder
Deprecated.
Assists the project builder.
DefaultProjectBuildingRequest
Deprecated.
As of 3.2.2, and there is no direct replacement.
Describes the interdependencies between projects in the reactor.
Default project realm cache implementation.
CacheKey
Utility to select projects for a given set of pom.xml files.
Handles expansion of general report plugin configuration into individual report sets.
Deprecated.
since maven 4.0, this class is now a no-op class and is only here for compatibility
Deprecated.
Collects basic settings to access the repository system.
Deprecated.
Deprecated.
Provides information about the current Maven runtime.
Builds the effective settings from a user settings file and/or a global settings file.
A factory to create settings builder instances when no dependency injection is available.
Collects settings that control building of effective settings.
Decrypts passwords in the settings.
Collects parameters that control the decryption of settings.
Describes a problem that was encountered during settings building.
Handles deserialization of settings from the default textual format.
Handles serialization of settings into the default textual format.
Provides the super POM that all models implicitly inherit from.
Default abstract toolchain implementation, to be used as base class for any toolchain implementation
to avoid rewriting usual code.
TODO: refactor this, component extending component is bad practice.
Deprecated.
instead use
DefaultToolchainsBuilderCollects toolchains that control building of effective toolchains.
Holds the result of the merged toolchains and holds the problems during this build, if any.
Handles deserialization of toolchains from the default textual format.
Handles serialization of toolchains into the default textual format.
Default implementation of
Type and Resolver ArtifactType.Deprecated.
Normalizes a URL.
A wrapper class around a resolver version that works as model version parser as well.
Default version scheme provider: provides singleton
GenericVersionScheme instance.Deprecated.
Deprecated.
Deprecated.
The
<dependency> element contains information about a dependency
of the project.Definition of a dependency, needed by the plugin at runtime.
Builder class used to create Dependency instances.
Builder class used to create Dependency instances.
The DependencyCollector service can be used to collect dependencies
for a given artifact and builds a graph of them.
Thrown in case of bad artifact descriptors, version ranges or other
issues encountered during calculation of the dependency graph.
A request to collect the transitive dependencies and to build a dependency graph from them.
The result of a dependency collection request.
Context of dependency artifacts for a particular project.
Section for management of default dependency information for use in a group of
POMs.
Builder class used to create DependencyManagement instances.
Handles the import of dependency management from other models into the target model.
Handles injection of dependency management into the model.
A request to resolve the dependencies of a project.
Exception that occurs when an artifact file is used, but has not been resolved.
The result of a project dependency resolution.
Collects, flattens and resolves dependencies.
Dependency scope.
Deployment repository contains the information needed for deploying to the remote
repository, which adds uniqueVersion property to usual repositories for download.
Builder class used to create DeploymentRepository instances.
Deprecated.
Information about one of the committers on this project.
Builder class used to create Developer instances.
This elements describes all that pertains to distribution for a project.
Builder class used to create DistributionManagement instances.
Relocation source from standard distribution management.
This exception is thrown if an application attempts to attach
two of the same artifacts to a single project.
DuplicateMojoDescriptorException
DuplicateParameterException
Signals a collision of two or more projects with the same g:a:v during a reactor build.
Exception that occurs when the project list contains duplicate projects instead of ignoring one.
ear packaging plugins bindings provider for default lifecycle.ejb packaging plugins bindings provider for default lifecycle.A component configurator which can leverage the
EnhancedConfigurationConverter
and EnhancedConverterLookup.Assists the project builder.
Event sent by maven during various phases of the build process.
Deprecated.
Deprecated.
A core extension to monitor Maven's execution.
Context
Dispatches callbacks to all registered EventSpies.
The possible types of execution events.
Transform an exception into useful end-user message.
Provide a summary of the exception, containing:
the exception itself,
useful end-user message,
useful reference to a solution, or set of solutions: this is usually a wiki page url in
http://cwiki.apache.org/confluence/display/MAVEN/,
child exception summaries.
Filter to exclude from a list of artifact patterns.
A dependency exclusion.
The
<exclusion> element contains information required to exclude
an artifact to the project.Builder class used to create Exclusion instances.
Filter to exclude from a list of artifact patterns.
Used if your Mojo needs to fork a lifecycle.
A set of goals to execute.
Builder class used to create Execution instances.
Holds data relevant for an execution event.
The possible types of execution events.
Assists in firing execution events.
Logs execution events to logger, eventually user-supplied.
Defines events that Maven fires during a build.
Wraps individual MojoExecutions, containing information about completion status and scheduling.
This annotation tags types that are part of an experimental API.
A plugin parameter expression supported by Maven.
The root of a parameter plugin expression document.
Deprecated.
Deprecated.
Interface that defines some kind of enums that can be extended by Maven plugins or extensions.
An SPI interface to extend Maven with a new enum value.
Describes a build extension to utilise.
Builder class used to create Extension instances.
Provides metadata about a build extension.
Creates an extension descriptor from some XML stream.
Caches extension class realms.
CacheRecord
A cache key.
Exception occurring trying to resolve a plugin.
Class inheriting SimpleLogger to work around the fact that the
ExtSimpleLogger.write(StringBuilder, Throwable)
method is package private.Deprecated.
A dependency traverser that excludes the dependencies of fat artifacts from the traversal.
Centralized class for Maven Core feature information.
Wraps an ordinary
File as a model source.Determines profile activation based on the existence/absence of some file.
Deprecated.
A PatternSet for files.
Builder class used to create FileSet instances.
Deprecated.
instead use
FileSourceFormats file size with the associated SI prefix
(GB, MB, kB) and using the patterns
#0.0 for numbers between 1 and 10
and ###0 for numbers between 10 and 1000+ by default.Wraps an ordinary
File as a source.Deprecated.
This annotation indicates that a type is automatically generated.
A task that is a goal.
Builds the
inter-dependencies graph between projects in the reactor.Deprecated.
Deprecated.
Deprecated.
Deprecated.
Base class for
Mirror, Profile, Proxy and Server.Builder class used to create IdentifiableBase instances.
The
Immutable annotation indicates that the object is immutable, i.e.Filter to include from a list of artifact patterns.
Handles inheritance of model values.
Class InputLocation.
Class InputLocation.
Class InputLocation.
Class InputLocation.
Class StringFormatter.
Class StringFormatter.
Class StringFormatter.
Class StringFormatter.
Interface InputLocationTracker.
Class InputSource.
Class InputSource.
Class InputSource.
Class InputSource.
Signals an internal error in Maven itself, e.g.
Exception thrown when the identity of an artifact can not be established,
e.g.
Thrown if a dependency has an invalid version.
InvalidPluginDescriptorException
InvalidPluginDescriptorException
Thrown when a plugin is not internally consistent.
Deprecated.
InvalidProjectVersionException
Error constructing an artifact repository.
Signals an error when adding a repository to the model resolver.
Occurs when a version is invalid.
Deprecated.
Information about the issue tracking (or bug tracking) system used to manage this
project.
Builder class used to create IssueManagement instances.
jar packaging plugins bindings provider for default lifecycle.The option of a Java command-line tool where to place the paths to some dependencies.
A specific
Toolchain dedicated for Java.JDK toolchain interface.
JDK toolchain factory.
JDK toolchain implementation.
Deprecated.
Determines profile activation based on the version of the current Java runtime.
The key defines an identity of a binding.
Language.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Helps to provide backward-compatibility with plugins that use legacy components.
Describes the licenses for this project.
Builder class used to create License instances.
A custom lifecycle mapping definition.
Lifecycle definition, with eventual plugin bindings (when they are not packaging-specific).
Lifecycle definition for a packaging (multiple packagings share the same lifecycle id = usually "default").
Builder class used to create Lifecycle instances.
Handles injection of plugin executions induced by the lifecycle bindings for a packaging.
Root element of the
lifecycle.xml file.Builder class used to create LifecycleConfiguration instances.
Logs debug output from the various lifecycle phases.
Resolves dependencies for the artifacts in context of the lifecycle build
A facade that provides lifecycle services to components outside Maven core.
LifecycleMapping
Lifecycle mapping delegate component interface.
Builds one or more lifecycles for a full module
Mojo (plugin goal) binding to a lifecycle phase.
Signals a failure to locate a lifecycle.
Mojo (goals) bindings to a lifecycle phase.
Signals a failure to locate the lifecycle for some phase.
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
Interface that can be provided by the plugin to wire in custom lifecycles
leveraged using the
Execute
annotation.Starts the build life cycle
A task that is a lifecycle.
Calculates the task segments in the build
A listener for session events.
Deprecated.
The local repository is used to cache artifacts downloaded from
RemoteRepository
and to hold artifacts that have been build locally.Deprecated.
This interface supplies the API for providing feedback to the user from the
There should be no big surprises here, although you may notice that the methods accept
Mojo, using standard
Maven channels.There should be no big surprises here, although you may notice that the methods accept
java.lang.CharSequence rather than java.lang.String.Deprecated.
Use SLF4J directly
Configuration for slf4j-log4j2.
Configuration for slf4j-logback.
Responsible for keeping state of whether the threshold of the --fail-on-severity flag has been hit.
The Exception class throw by the
Lookup service.This element describes all of the mailing lists associated with a project.
Builder class used to create MailingList instances.
Deprecated.
The main Maven execution entry point, which will execute a full Maven execution session.
Deprecated.
The keys for Maven specific properties of artifacts.
Maven relocation source.
Abstraction of an artifact repository.
MavenBuildTimestamp
A maven workspace reader that delegates to a chain of other readers, effectively aggregating their contents.
A dependency graph transformer that refines the request context for nodes that belong to the "project" context by
appending the buildpath type to which the node belongs.
The dependency scopes used for Java dependencies in Maven.
Base class for all maven exceptions.
MavenExecutionPlan
Assists in populating an execution request for invocation of Maven.
A proxy which enhances the MavenSimpleLogger with functionality to track whether a logging threshold is hit.
LogFactory for Maven which can create a simple logger or one which, if set, fails the build on a severity threshold.
Use to compute keys for data structures
Deprecated.
Deprecated.
The domain-specific model merger for the Maven POM, overriding generic code from parent class when necessary with
more adapted algorithms.
Service responsible for validating plugin configuration.
maven-plugin packaging plugins bindings provider for default lifecycle.Provides basic services to manage Maven plugins and their mojos.
Service responsible for checking if plugin's prerequisites are met.
MavenPluginValidator
The concern of the project is provide runtime values based on the model.
Deprecated.
use
ProjectBuilder insteadConvenience interface for plugins to add or replace artifacts and resources on projects.
Deprecated.
Deprecated.
A scope deriver for use with
ConflictResolver that supports the scopes from MavenDependencyScopes.A scope selector for use with
ConflictResolver that supports the scopes from MavenDependencyScopes.A Maven execution session.
A simple
Supplier of RepositorySystemSession.SessionBuilder instances, that on each call supplies newly
constructed instance.Deprecated.
Deprecated.
use
SettingsMergerLogger for Maven, that support colorization of levels and stacktraces.
Utility for Maven to access Slf4j internals through package access.
Utility for Maven to access Slf4j-Simple internals through package access.
Wrapper for creating loggers which can have a log level threshold.
A system scope handler.
Use to compute keys for data structures
MavenWorkspaceReader
Deprecated.
Use MavenStaxReader instead
Deprecated.
Use MavenStaxReader instead
Deprecated.
Use MavenStaxWriter instead
Deprecated.
Use MavenStaxWriter instead
Message builder that supports configurable styling.
A factory for
MessageBuilder.Builder class used to create Metadata instances.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Signals a failure to parse the metadata due to invalid syntax (e.g.
Handles deserialization of metadata from some kind of textual format like XML.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Storage location for metadata
Deprecated.
Deprecated.
Maven 3 compatability - please use
MetadataStaxReaderDeprecated.
Maven 3 compatability - please use
MetadataStaxWriterA download mirror for a given repository.
Builder class used to create Mirror instances.
Deprecated.
MissingModuleException
Signals that the user referenced one or more Maven profiles that could not be located in either the project or the
settings.
Signals a failure to execute a lifecycle phase or mojo because a project is required but not present.
Deprecated.
The
<project> element is the root of the descriptor.Builder class used to create Model instances.
Base class for the
Model and the Profile objects.Builder class used to create ModelBase instances.
Builds the effective model from a POM.
Holds data relevant for a model building event.
Signals one ore more errors during model building.
Defines events that the model builder fires during construction of the effective model.
Collects settings that control the building of effective models.
Collects the output of the model builder.
Caches auxiliary data used during model building like already processed raw/effective models.
Factory for
ModelCache objects.Deprecated.
Deprecated.
Replaces expressions of the form
${token} with their effective values.Deprecated.
Locates a POM file within a project base directory.
Handles normalization of a model.
Signals a failure to parse the POM due to invalid syntax (e.g.
The
ModelParser interface is used to locate and read Models from the file system.Resolves relative paths of a model against a specific base directory.
Describes a problem that was encountered during model building.
The different severity levels for a problem, in decreasing order.
Version
Collects problems that are encountered during model building.
Extends the ModelProblemCollector by the capacity of returning the collected problems.
Class to wrap request parameters to ModelProblemCollector.addProblem
Assists in the handling of model problems.
ModelProcessor
Handles deserialization of a model from some kind of textual format like XML.
Resolves a POM from its coordinates.
Deprecated.
instead use
SourceProvides access to the contents of a POM independently of the backing store (e.g.
Enhancement to the
ModelSource2 to support locating POM files using the ModelLocator
when pointing to a directory.The ModelSourceTransformer is a way to transform the local pom while streaming the input.
Normalizes URLs to remove the ugly parent references "../" that got potentially inserted by URL adjustment during
model inheritance.
Deprecated.
Deprecated.
Checks the model for missing or invalid values.
Deprecated.
Model builder specific version parser.
Allows a fixed set of properties that are valid inside a version and that could be overwritten for example on the
commandline
Handles serialization of a model into some kind of textual format like XML.
Reads or writes a
Model using XML.This annotation will mark your class as a Mojo (ie.
This interface forms the contract required for
It features an
Mojos to interact with the Maven
infrastructure.It features an
execute() method, which triggers the Mojo's build-process behavior, and can throw
a MojoException if error conditions occur.This interface forms the contract required for
It features an
Also included is the
Mojos to interact with the Maven
infrastructure.It features an
execute() method, which triggers the Mojo's build-process behavior, and can throw
a MojoExecutionException or MojoFailureException if error conditions occur.Also included is the
setLog(...) method, which simply allows Maven to inject a logging mechanism which
will allow the Mojo to communicate to the outside world through standard Maven channels.A Mojo description.
The bean containing the Mojo descriptor.
For more information about the usage tag, have a look to: https://maven.apache.org/developers/mojo-api-specification.html TODO is there a need for the delegation of MavenMojoDescriptor to this? Why not just extend ComponentDescriptor here?
For more information about the usage tag, have a look to: https://maven.apache.org/developers/mojo-api-specification.html TODO is there a need for the delegation of MavenMojoDescriptor to this? Why not just extend ComponentDescriptor here?
Builder class used to create MojoDescriptor instances.
Resolves dependencies for the artifacts in context of the lifecycle build
An exception occurring during the execution of a plugin.
A
MojoExecution represents a single execution of a Maven Plugin during a given build.MojoExecution
Describes the source of an execution.
A MojoExecutionConfigurator is responsible for creating the configuration for Mojo based on configuration for a Mojo
in the MavenProject and the default configuration for the Mojo from the containing plugin's plugin.xml descriptor.
Encapsulates parameters of MojoExecutionListener callback methods and is meant to provide API evolution path should
it become necessary to introduce new parameters in the existing callbacks in the future.
An exception occurring during the execution of a plugin.
Throwing this exception causes a "BUILD ERROR" message to be displayed.
Throwing this exception causes a "BUILD ERROR" message to be displayed.
Extension point that allows build extensions observe and possibly veto mojo executions.
Provides context for mojo execution.
MojoExecutionScope
MojoExecutionScopeCoreModule
Indicates that the annotated bean has a lifespan limited to a given mojo execution,
which means each mojo execution will result in a different instance being injected.
Indicates that annotated component should be instantiated before mojo execution starts and discarded after mojo
execution completes.
MojoExecutionScopeModule
Executes an individual mojo
An exception occurring during the execution of a plugin (such as a compilation failure).
Throwing this exception causes a "BUILD FAILURE" message to be displayed.
Throwing this exception causes a "BUILD FAILURE" message to be displayed.
MojoNotFoundException
Interface allows overriding default mojo execution strategy For example it is possible wrap some mojo execution to
decorate default functionality or skip some executions
Helper class to format multiline messages to the console
Strategy for collecting Maven projects from the multi-module project root, even when executed in a submodule.
Exception caused when one or more artifacts can not be resolved because they are not found in the
local or remote repositories.
Builds the full lifecycle in weave-mode (phase by phase as opposed to project-by-project).
Deprecated.
Deprecated.
Represents a dependency node within a Maven project's dependency collector.
Defines a hierarchical visitor for collecting dependency node trees.
Signals a failure to build because no goal was specified.
The annotated element must not be null.
NoPluginFoundForPrefixException
Configures one method for notifying users/developers when a build breaks.
Builder class used to create Notifier instances.
This annotation indicates that the annotated type is not threadsafe
and should only be used by a single thread.
The annotated element can be
null.Wraps an object, providing reflective access to the object graph of which the
supplied object is the root.
Deprecated.
Determines profile activation based on the operating system of the current runtime platform.
Deprecated.
Deprecated.
Specifies the organization that produces this project.
Builder class used to create Organization instances.
OS support
Occurs when ranges exclude each other and no valid value remains.
Interface representing a Maven project packaging.
Determines profile activation based on the project's packaging.
Class ParamdocXpp3Reader.
Class ParamdocXpp3Writer.
Used to configure your Mojo parameters to be injected by
MavenPluginManager.getConfiguredMojo(...).A phase mapping definition.
Builder class used to create Parameter instances.
The
<parent> element contains information required to locate the parent project from which
this project will inherit from.Builder class used to create Parent instances.
Path scope.
Deprecated.
Resolves relative paths against a specific base directory.
Deprecated.
The option of a command-line tool where to place the paths to some dependencies.
Definition of include or exclude patterns.
Builder class used to create PatternSet instances.
The
<toolchains> element is the root of the descriptor.Builder class used to create PersistedToolchains instances.
A phase mapping definition.
Builder class used to create Phase instances.
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
PlexusBeanConverter Module that converts Plexus XML configuration into beans.The
<plugin> element contains information required for a plugin.Represents a maven plugin runtime
Mapping information for a single plugin within this group.
Builder class used to create Plugin instances.
Builder class used to create Plugin instances.
PluginArtifact
Caches plugin artifacts.
CacheRecord
A cache key.
Contains the plugins management information for the project.
Builder class used to create PluginConfiguration instances.
Handles expansion of general build plugin configuration into individual executions.
Contains the plugins information for the project.
Builder class used to create PluginContainer instances.
Exception which occurs to indicate that the plugin cannot be initialized due
to some deeper problem with Plexus.
Assists in resolving the dependencies of a plugin.
Root element of the
plugin.xml file.Builder class used to create PluginDescriptor instances.
Caches raw plugin descriptors.
A cache key.
The
@lt;execution> element contains information required for the
execution of a plugin.Builder class used to create PluginExecution instances.
Exception in the plugin manager.
Signals a plugin which is not compatible with the current Maven runtime.
Signifies a failure to load a plugin.
Section for management of default plugin information for use in a group of POMs.
Builder class used to create PluginManagement instances.
Handles injection of plugin management into the model.
Deprecated.
Exception in the plugin manager.
Exception occurring trying to resolve a plugin.
PluginParameterException
Evaluator for plugin parameters expressions.
Evaluator for plugin parameters expressions.
Collects settings required to resolve a plugin prefix.
Resolves a plugin prefix.
Describes the result of a plugin prefix resolution request.
Caches plugin class realms.
CacheRecord
A cache key.
Exception occurring trying to resolve a plugin.
Maven G level metadata generator factory.
Component collecting plugin validation issues and reporting them.
PluginVersionNotFoundException
Collects settings required to resolve the version for a plugin.
PluginVersionResolutionException
Resolves a version for a plugin.
Describes the result of a plugin version resolution request.
Reads and writes a
PluginDescriptor object to/from XML.Strategy to collect projects for building when the Maven invocation is not in a directory that contains a pom.xml.
pom packaging plugins bindings provider for default lifecycle.Wraps an arbitrary object with an
ObjectBasedValueSource instance, then
wraps that source with a PrefixedValueSourceWrapper instance, to which
this class delegates all of its calls.Describes the prerequisites a project can have.
Builder class used to create Prerequisites instances.
Describes a problem that was encountered during settings building.
The different severity levels for a problem, in decreasing order.
Collects problems that are encountered during settings building.
Modifications to the build process which is activated based on environmental
parameters or command line arguments.
Modifications to the build process which is keyed on some sort of environmental parameter.
Modifications to the build process which is keyed on
some
sort of environmental parameter.
Builder class used to create Profile instances.
Builder class used to create Profile instances.
Container for storing the request from the user to activate or de-activate certain profiles and optionally fail the
build if those profiles do not exist.
Describes the environmental context used to determine the activation status of profiles.
Deprecated.
Finds an absolute path for
ActivationFile.getExists() or ActivationFile.getMissing()Determines whether a profile should be activated.
Deprecated.
Handles profile injection into the model.
Deprecated.
Deprecated.
Calculates the active profiles among a given collection of profiles.
Root element of the profiles.xml file.
Class ProfilesXpp3Reader.
Class ProfilesXpp3Writer.
Interface representing a Maven project which can be created using the
ProjectBuilder service.Container for storing the request from the user to activate or deactivate certain projects and optionally fail the
build if those projects do not exist.
ProjectArtifact
Component interface responsible for creation of MavenProject#dependencyArtifacts instances.
Deprecated.
Caches project artifacts.
CacheRecord
A cache key.
Builds in-memory descriptions of projects.
Deprecated.
use
ProjectBuildingRequest insteadThe Exception class throw by the
ProjectBuilder service.Request used to build a
Project using
the ProjectBuilder service.Result of a project build call.
Exception which occurs when a normal (i.e.
Assists the project builder.
ProjectBuildingRequest
The possible merge modes for combining remote repositories.
Collects the output of the project builder.
A list of project segments, ordered so that all ProjectSegments from first TaskSegment come before any
subsequent TaskSegments.
Describes strategies for finding projects that Maven could build.
Resolves the transitive dependencies of a project.
Deprecated.
As of 3.2.2, and there is no direct replacement.
Describes the interdependencies between projects in the reactor.
Encapsulates parameters of ProjectExecutionListener callback methods and is meant to provide API evolution path
should it become necessary to introduce new parameters in the existing callbacks in the future.
Extension point that allows build extensions observe and possibly veto project build execution.
Provides the positional index of the project
Interface to manage the project during its lifecycle.
A model resolver to assist building of projects.
Caches project class realms.
CacheRecord
A cache key.
Project scope.
Manager for
ProjectScope.A build context that matches a Maven project to a given task segment, and the session to be used.
Utility class to extract
MavenProject from the project graph during the execution phase based on optional or
required selectors.ProjectSorter
Facade to select projects for a given set of pom.xml files.
Deprecated.
Service used to interact with the end user.
The Exception class throw by the
Prompter service.Component able to contribute to Maven session user properties.
Determines profile activation based on the existence or value of some execution property.
A type implemented by, or extended by maven itself.
Can be used on a static method to provide a bean.
The
<proxy> element contains information required to a proxy settings.Proxy
Builder class used to create Proxy instances.
rar packaging plugins bindings provider for default lifecycle.Contains status information that is global to an entire reactor build.
Context that is fixed for the entire reactor build.
Deprecated.
Using simple dotted expressions to extract the values from an Object instance using JSP-like expressions
such as
project.build.sourceDirectory.Deprecated.
Deprecated.
Describes where an artifact has moved to.
Builder class used to create Relocation instances.
A remote repository that can be used to download or upload artifacts.
Handles expansion of general report plugin configuration into individual report sets.
Section for management of reports and their configuration.
Builder class used to create Reporting instances.
Deprecated.
since maven 4.0, this interface is not used anymore and is only here for compatibility
The
<plugin> element in <reporting><plugins> contains information required for a report plugin.Builder class used to create ReportPlugin instances.
Represents a set of reports and configuration to be used to generate them.
Builder class used to create ReportSet instances.
A repository contains the information needed for establishing connections with
remote repository.
A repository holds artifacts.
Repository contains the information needed for establishing
connections with remote repository
Repository contains the information needed for
establishing connections with remote repository
.
Builder class used to create Repository instances.
Builder class used to create Repository instances.
A repository contains the information needed for establishing connections with
remote repository.
Repository contains the information needed
for establishing connections with remote repository
Repository contains the information needed
for establishing connections with remote repository
.
Builder class used to create RepositoryBase instances.
Builder class used to create RepositoryBase instances.
Deprecated.
Factory service to create
LocalRepository or RemoteRepository objects.Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Problem storing the repository metadata in the local repository.
Download policy.
Download policy
Download policy.
Builder class used to create RepositoryPolicy instances.
Builder class used to create RepositoryPolicy instances.
Collects basic settings to access the repository system.
Component interface that allows per-project customization of Aether repository system sessions.
Deprecated.
Use
MavenRepositorySystem if needed, or maven-resolver directly, until maven 4.x api is outFactory for Resolver session.
Warning: This is an internal utility class that is only public for technical reasons, it is not part
of the public API.
Strategy to collect projects based on the
-f CLI parameter or the pom.xml in the working directory.Describes a component requirement.
Describes a component requirement.
Builder class used to create Requirement instances.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Resolve relative file path against the given base directory
This element describes all of the classpath resources associated with a project
or unit tests.
Builder class used to create Resource instances.
Describes a restriction in versioning.
There are various forms of results that are represented by this class:
success - in which case only the model field is set
success with warnings - model field + non-error model problems
error - no model, but diagnostics
error - (partial) model and diagnostics
Could encode these variants as subclasses, but kept in one for now
Interface used to locate the root directory for a given project.
Deprecated.
Use
RuntimeInformation instead.Provides information about the current Maven runtime.
The
<scm> element contains information required to the SCM
(Source Control Management) of the project.Builder class used to create Scm instances.
Filter to only retain objects in the given artifactScope or better.
The
<server> element contains information required to a server settings.Builder class used to create Server instances.
Marker interface for all services provided by the
Session.The session to install / deploy / resolve artifacts and dependencies.
A container for data that is specific to a session.
Key used to query the session data
SessionScope
A provider wrapping an existing provider with a cache
ScopeState
Indicates that annotated component should be instantiated before session execution starts
and discarded after session execution completes.
Indicates that annotated component should be instantiated before session execution starts
and discarded after session execution completes.
SessionScopeModule
Root element of the user configuration file.
Builder class used to create Settings instances.
Builds the effective settings from a user settings file and/or a global settings file.
Builds the effective settings from a user settings file, a project settings file
and/or a global settings file.
The Exception class throw by the
SettingsBuilder.Collects settings that control the building of effective settings.
Signals one ore more errors during settings building.
Collects settings that control the building of effective settings.
Collects the output of the settings builder.
If there was an error in the settings file.
Decrypts passwords in the settings.
Collects parameters that control the decryption of settings.
Collects the output of the settings decrypter.
Use to compute keys for data structures
Signals a failure to parse the settings due to invalid syntax (e.g.
Describes a problem that was encountered during settings building.
The different severity levels for a problem, in decreasing order.
Collects problems that are encountered during settings building.
Handles deserialization of settings from some kind of textual format like XML.
Deprecated.
instead use
SourceSeveral convenience methods to handle settings
Several convenience methods to handle settings
Validate a model settings
Handles serialization of settings into some kind of textual format like XML.
SettingsXmlConfigurationProcessor
Reads and writes a
Settings object to/from XML.Deprecated.
Maven 3 compatibility - please use
org.apache.maven.api.services.xml.SettingsXmlFactory from maven-api-core
or SettingsStaxReaderDeprecated.
Maven 3 compatibility - please use
org.apache.maven.api.services.xml.SettingsXmlFactory from maven-api-core
or SettingsStaxWriter
Simple implementation of
Logger that sends all enabled log messages,
for all defined loggers, to the console (System.err).This class holds configuration values for
SimpleLogger.An implementation of
ILoggerFactory which always returns
SimpleLogger instances.A
TransferListener implementation that wraps another delegate TransferListener but makes it run
on single thread, keeping the listener logic simple.
A
Builder encapsulates a strategy for building a set of Maven projects.Contains the information needed for deploying websites.
Builder class used to create Site instances.
site lifecycle provider.Interface for configuration operations on loggers, which are not available in slf4j, then require per-slf4f-binding
implementation.
Level
Slf4jConfiguration factory, loading implementations from
META-INF/maven/slf4j-configuration.properties
configuration files in class loader: key is the class name of the ILoggerFactory, value is the class name of
the corresponding Slf4jConfiguration.Adapt an SLF4J logger to a Plexus logger, ignoring Plexus logger API parts that are not classical and
probably not really used.
Use an SLF4J
ILoggerFactory as a backing for a Plexus
LoggerManager,
ignoring Plexus logger API parts that are not classical and probably not really used.Slf4jMavenTransferListener
Configuration for slf4j-simple.
Snapshot data for the last artifact corresponding to the SNAPSHOT base version
Builder class used to create Snapshot instances.
Deprecated.
Maven GAV level metadata generator factory.
Deprecated.
Versioning information for a sub-artifact of the current snapshot artifact.
Builder class used to create SnapshotVersion instances.
Provides access to the contents of a source independently of the
backing store (e.g.
Provides access to the contents of a source independently of the backing store (e.g.
Marker interface to indicate services that can be provided by plugins and extensions.
Deprecated.
instead use
StringSourceDeprecated.
Deprecated.
instead use
StringSourceWraps an ordinary
CharSequence as a source.StringVisitorModelInterpolator
Provides the super POM that all models implicitly inherit from.
Provides the super POM that all models implicitly inherit from.
Exceptions thrown by the
SuperPomProvider service.Deprecated.
Deprecated.
Use SLF4J directly
A Maven task, at this level is merely just an opaque string.
Describes the required task segment as provided on the maven command line; i.e.
NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
The
ThreadSafe annotation can be used to indicate a given type
is thread safe.Toolchain interface.
Toolchain interface.
Internal toolchain factory, to prepare toolchains instances.
Service to manage
Toolchains.Public API for a toolchain-aware plugin to get expected toolchain instance.
The Exception class throw by the
ToolchainManager.Component for use by the
maven-toolchains-plugin only.Definition of a toolchain instance.
Builder class used to create ToolchainModel instances.
a private contract between the toolchains plugin and the components.
Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
Deprecated.
use
ToolchainsBuilder insteadThe Exception class throw by the
ToolchainsBuilder.Collects toolchains that control the building of effective toolchains.
Collects the output of the toolchains builder.
Signals a failure to parse the toolchains due to invalid syntax (e.g.
Handles deserialization of toolchains from some kind of textual format like XML.
Handles serialization of toolchains into some kind of textual format like XML.
Reads and writes a
PersistedToolchains object to/from XML.common base class that contains code to track the source for
this instance (USER|GLOBAL)
Common base class that contains code to track the source for this instance (USER|GLOBAL)
Builder class used to create TrackableBase instances.
Builder class used to create TrackableBase instances.
Deprecated.
Exception that may be thrown by the
Artifact.getFile()
implementation.Context used to transform a pom file.
The transformerContextBuilder is responsible for initializing the TransformerContext.
Transport for specified remote repository (using provided remote repository base URI as root).
Transporter provider is a service that provides somewhat trivial transport capabilities backed by Maven internals.
A dependency's
Type is uniquely identified by a String,
and semantically represents a known kind of dependency.Deprecated.
Access to
Type registry.Various helper methods for type processing
Deprecated.
Signals an error when resolving the path to an external model.
Deprecated.
Pseudo-configuration for unsupported SLF4J binding.
Deprecated.
Deprecated.
instead use
UrlSourceNormalizes a URL to remove the ugly parent references "../" that got potentially inserted by URL adjustment during
model inheritance.
Deprecated.
instead use
UrlSourceWraps an ordinary
URL as a source.Deprecated.
Relocation source from user properties.
A version usually parsed using the
VersionParser service.Version constraint for dependency.
Versioning information for "groupId/artifactId" or "groupId/artifactId/version" SNAPSHOT
Builder class used to create Versioning instances.
Deprecated.
Service interface to parse
Version and VersionRange.The Exception class thrown by
VersionParser.A range of versions.
Construct a version range from a specification.
Represents range boundary.
Parses and evaluates version ranges encountered in dependency declarations.
Resolves artifact meta/pseudo versions.
Maven GA level metadata generator factory.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
war packaging plugins bindings provider for default lifecycle.Deprecated.
Extension point that allows build extensions observe and possibly veto mojo executions.
WorkspaceModelResolver
wrapper lifecycle provider.Generic interface to read/write objects to/from XML.
An immutable xml node.
All methods in this class attempt to fully parse the XML.
Input location builder interface, to be implemented to choose how to store data.
NOTE: remove all the util code in here when separated, this class should be pure data.
An exception thrown during the reading of an xml file.
An XML reader request.
An exception thrown during the writing of an xml file.
An XML writer request.
META-INF/maven/extension.xmlto define artifacts exported by Maven core extensions.