Package org.apache.maven.api

Interface Session

All Superinterfaces:

ProtoSession

@Experimental
@ThreadSafe
public interface Session
extends ProtoSession

The session to install / deploy / resolve artifacts and dependencies.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.api.ProtoSession

ProtoSession.Builder

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact, PathScope scope)	Shortcut for getService(DependencyResolver.class).collect(...)
Node	collectDependencies(DependencyCoordinates dependency, PathScope scope)	Collects the transitive dependencies of some artifacts and builds a dependency graph.
Node	collectDependencies(Project project, PathScope scope)	Shortcut for getService(DependencyResolver.class).collect(...)
Artifact	createArtifact(String groupId, String artifactId, String version, String extension)	Shortcut for getService(ArtifactFactory.class).create(...).
Artifact	createArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(ArtifactFactory.class).create(...).
ArtifactCoordinates	createArtifactCoordinates(String coordsString)	Creates a coordinates out of string that is formatted like: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>.
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String extension)	Shortcut for getService(ArtifactFactory.class).create(...).
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(ArtifactFactory.class).create(...).
ArtifactCoordinates	createArtifactCoordinates(Artifact artifact)	Shortcut for getService(ArtifactFactory.class).create(...).
DependencyCoordinates	createDependencyCoordinates(ArtifactCoordinates coordinates)	Shortcut for getService(DependencyFactory.class).create(...).
DependencyCoordinates	createDependencyCoordinates(Dependency dependency)	Shortcut for getService(DependencyFactory.class).create(...).
LocalRepository	createLocalRepository(Path path)	Shortcut for getService(RepositoryFactory.class).createLocal(...).
ProducedArtifact	createProducedArtifact(String groupId, String artifactId, String version, String extension)	Shortcut for getService(ArtifactFactory.class).createProduced(...).
ProducedArtifact	createProducedArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(ArtifactFactory.class).createProduced(...).
RemoteRepository	createRemoteRepository(String id, String url)	Shortcut for getService(RepositoryFactory.class).createRemote(...).
RemoteRepository	createRemoteRepository(Repository repository)	Shortcut for getService(RepositoryFactory.class).createRemote(...).
void	deployArtifact(RemoteRepository repository, ProducedArtifact... artifacts)	Shortcut for getService(ArtifactDeployer.class).deploy(...).
List<Node>	flattenDependencies(Node node, PathScope scope)	Shortcut for getService(DependencyResolver.class).flatten(...).
Optional<Path>	getArtifactPath(Artifact artifact)	Shortcut for getService(ArtifactManager.class).getPath(...).
SessionData	getData()	Retrieves the session data associated with this session.
int	getDegreeOfConcurrency()	Returns the degree of concurrency for the build.
Map<String,String>	getEffectiveProperties(Project project)	Each invocation computes a new map of effective properties.
Collection<Listener>	getListeners()	Returns the list of registered listeners.
LocalRepository	getLocalRepository()	Retrieves the local repository associated with this session.
Version	getMavenVersion()	Returns the current maven version.
Path	getPathForLocalArtifact(Artifact artifact)	Gets the relative path for a locally installed artifact.
Path	getPathForRemoteArtifact(RemoteRepository remote, Artifact artifact)	Gets the relative path for an artifact cached from a remote repository.
Map<String,Object>	getPluginContext(Project project)	Returns the plugin context for mojo being executed and the specified Project, never returns null as if context not present, creates it.
List<Project>	getProjects()	Retrieves a list of projects associated with the session.
List<RemoteRepository>	getRemoteRepositories()	Retrieves a list of remote repositories associated with this session.
<T extends Service> T	getService(Class<T> clazz)	Retrieves the service for the interface
org.apache.maven.api.settings.Settings	getSettings()	Retrieves the settings for the current session.
Collection<org.apache.maven.api.toolchain.ToolchainModel>	getToolchains()	Retrieves toolchain models that have been explicitly configured.
void	installArtifacts(Collection<ProducedArtifact> artifacts)	Shortcut for getService(ArtifactInstaller.class).install(...).
void	installArtifacts(ProducedArtifact... artifacts)	Shortcut for getService(ArtifactInstaller.class).install(...).
boolean	isVersionSnapshot(String version)	Checks whether a given artifact version is considered a SNAPSHOT or not.
Version	parseVersion(String version)	Parses the specified version string, for example "1.0".
VersionConstraint	parseVersionConstraint(String versionConstraint)	Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".
VersionRange	parseVersionRange(String versionRange)	Parses the specified version range specification, for example "[1.0,2.0)".
void	registerListener(Listener listener)	Register the given listener which will receive all events.
DependencyScope	requireDependencyScope(String id)	Obtain the DependencyScope from the specified id.
Language	requireLanguage(String id)	Obtain the Language from the specified id.
Packaging	requirePackaging(String id)	Obtain the Packaging from the specified id.
PathScope	requirePathScope(String id)	Obtain the PathScope from the specified id.
ProjectScope	requireProjectScope(String id)	Obtain the ProjectScope from the specified id.
Type	requireType(String id)	Obtain the Type from the specified id.
DownloadedArtifact	resolveArtifact(Artifact artifact)	Shortcut for getService(ArtifactResolver.class).resolve(...).
DownloadedArtifact	resolveArtifact(ArtifactCoordinates coordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
DownloadedArtifact	resolveArtifact(ArtifactCoordinates coordinates, List<RemoteRepository> repositories)	Shortcut for getService(ArtifactResolver.class).resolve(...).
DownloadedArtifact	resolveArtifact(Artifact artifact, List<RemoteRepository> repositories)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Collection<DownloadedArtifact>	resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Collection<DownloadedArtifact>	resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates, List<RemoteRepository> repositories)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Collection<DownloadedArtifact>	resolveArtifacts(Artifact... artifacts)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Collection<DownloadedArtifact>	resolveArtifacts(ArtifactCoordinates... coordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
List<Path>	resolveDependencies(List<DependencyCoordinates> dependencyCoordinates)	Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().
List<Path>	resolveDependencies(DependencyCoordinates dependencyCoordinates)	Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().
Map<PathType,List<Path>>	resolveDependencies(DependencyCoordinates dependencyCoordinates, PathScope scope, Collection<PathType> desiredTypes)	Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().
List<Path>	resolveDependencies(Project project, PathScope scope)	Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().
Map<PathType,List<Path>>	resolveDependencies(Project project, PathScope scope, Collection<PathType> desiredTypes)	Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().
Optional<Version>	resolveHighestVersion(ArtifactCoordinates artifact, List<RemoteRepository> repositories)	Resolves the highest available version of a version range.
Version	resolveVersion(ArtifactCoordinates artifact)	Resolves an artifact's meta version (if any) to a concrete version.
List<Version>	resolveVersionRange(ArtifactCoordinates artifact)	Expands a version range to a list of matching versions, in ascending order.
List<Version>	resolveVersionRange(ArtifactCoordinates artifact, List<RemoteRepository> repositories)	Expands a version range to a list of matching versions, in ascending order.
void	setArtifactPath(ProducedArtifact artifact, Path path)	Shortcut for getService(ArtifactManager.class).setPath(...).
void	unregisterListener(Listener listener)	Unregisters a previously registered listener.
Session	withLocalRepository(LocalRepository localRepository)	Creates a derived session using the given local repository.
Session	withRemoteRepositories(List<RemoteRepository> repositories)	Creates a derived session using the given remote repositories.

Methods inherited from interface org.apache.maven.api.ProtoSession

getRootDirectory, getStartTime, getSystemProperties, getTopDirectory, getUserProperties, toBuilder

Method Details

getMavenVersion

@Nonnull
Version getMavenVersion()

Returns the current maven version.

Returns:

the maven version, never null

getSettings

@Nonnull
org.apache.maven.api.settings.Settings getSettings()

Retrieves the settings for the current session.

Returns:

the settings instance

getToolchains

@Nonnull
Collection<org.apache.maven.api.toolchain.ToolchainModel> getToolchains()

Retrieves toolchain models that have been explicitly configured.

Returns:

the toolchain models

getLocalRepository

@Nonnull
LocalRepository getLocalRepository()

Retrieves the local repository associated with this session.

Returns:

the local repository instance

getRemoteRepositories

@Nonnull
List<RemoteRepository> getRemoteRepositories()

Retrieves a list of remote repositories associated with this session.

Returns:

a list of remote repositories

getData

@Nonnull
SessionData getData()

Retrieves the session data associated with this session.

Returns:

the session data, never null

getEffectiveProperties

@Nonnull
Map<String,String> getEffectiveProperties(@Nullable
 Project project)

Each invocation computes a new map of effective properties. To be used in interpolation.

Effective properties are computed from system, user and optionally project properties, layered with defined precedence onto each other to achieve proper precedence. Precedence is defined as:

• System properties (lowest precedence)
• Project properties (optional)
• User properties (highest precedence)

Note: Project properties contains properties injected from profiles, if applicable. Their precedence is profile > project, hence active profile property may override project property.

The caller of this method should decide whether there is a project in scope (hence, a project instance needs to be passed) or not.

Parameters:

project - Project or null.

Returns:

the effective properties, never null

getDegreeOfConcurrency

int getDegreeOfConcurrency()

Returns the degree of concurrency for the build.

Returns:

the degree of concurrency

getProjects

@Nonnull
List<Project> getProjects()

Retrieves a list of projects associated with the session.

Returns:

a list of projects, never null

getPluginContext

@Nonnull
Map<String,Object> getPluginContext(@Nonnull
 Project project)

Returns the plugin context for mojo being executed and the specified Project, never returns null as if context not present, creates it. Implementation note: while this method return type is Map, the returned map instance implements ConcurrentMap as well.

Throws:

MavenException - if not called from the within a mojo execution

getService

@Nonnull
<T extends Service> T getService(@Nonnull
 Class<T> clazz)

Retrieves the service for the interface

Throws:

NoSuchElementException - if the service could not be found

withLocalRepository

@Nonnull
Session withLocalRepository(@Nonnull
 LocalRepository localRepository)

Creates a derived session using the given local repository.

Parameters:

localRepository - the new local repository

Returns:

the derived session

Throws:

NullPointerException - if localRepository is null

withRemoteRepositories

@Nonnull
Session withRemoteRepositories(@Nonnull
 List<RemoteRepository> repositories)

Creates a derived session using the given remote repositories.

Parameters:

repositories - the new list of remote repositories

Returns:

the derived session

Throws:

NullPointerException - if repositories is null

registerListener

void registerListener(@Nonnull
 Listener listener)

Register the given listener which will receive all events.

Parameters:

listener - the listener to register

Throws:

NullPointerException - if listener is null

unregisterListener

void unregisterListener(@Nonnull
 Listener listener)

Unregisters a previously registered listener.

Parameters:

listener - the listener to unregister

Throws:

NullPointerException - if listener is null

getListeners

@Nonnull
Collection<Listener> getListeners()

Returns the list of registered listeners.

Returns:

an immutable collection of listeners, never null

createLocalRepository

@Nonnull
LocalRepository createLocalRepository(@Nonnull
 Path path)

Shortcut for getService(RepositoryFactory.class).createLocal(...).

Parameters:

path - location of the local repository to create

Returns:

cache of artifacts downloaded from a remote repository or built locally

See Also:

• RepositoryFactory.createLocal(Path)

createRemoteRepository

@Nonnull
RemoteRepository createRemoteRepository(@Nonnull
 String id,
 @Nonnull
 String url)

Shortcut for getService(RepositoryFactory.class).createRemote(...).

Parameters:

id - identifier of the remote repository to create

url - location of the remote repository

Returns:

remote repository that can be used to download or upload artifacts

See Also:

• RepositoryFactory.createRemote(String, String)

createRemoteRepository

@Nonnull
RemoteRepository createRemoteRepository(@Nonnull
 Repository repository)

Shortcut for getService(RepositoryFactory.class).createRemote(...).

Parameters:

repository - information needed for establishing connections with remote repository

Returns:

remote repository that can be used to download or upload artifacts

See Also:

• RepositoryFactory.createRemote(Repository)

createArtifactCoordinates

@Nonnull
ArtifactCoordinates createArtifactCoordinates(@Nonnull
 String coordsString)

Creates a coordinates out of string that is formatted like: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>.

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

coordsString - the string having "standard" coordinates.

Returns:

coordinates used to point to the artifact

See Also:

• ArtifactCoordinatesFactory.create(Session, String)

createArtifactCoordinates

@Nonnull
ArtifactCoordinates createArtifactCoordinates(String groupId,
 String artifactId,
 String version,
 String extension)

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

extension - the artifact extension, or null is unspecified

Returns:

coordinates used to point to the artifact

See Also:

• ArtifactCoordinatesFactory.create(Session, String, String, String, String)

createArtifactCoordinates

@Nonnull
ArtifactCoordinates createArtifactCoordinates(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

classifier - the artifact classifier, or null is unspecified

extension - the artifact extension, or null is unspecified

type - the artifact type, or null is unspecified

Returns:

coordinates used to point to the artifact

See Also:

• ArtifactCoordinatesFactory.create(Session, String, String, String, String, String, String)

createArtifactCoordinates

@Nonnull
ArtifactCoordinates createArtifactCoordinates(@Nonnull
 Artifact artifact)

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

artifact - artifact from which to get coordinates

Returns:

coordinates used to point to the artifact

See Also:

• ArtifactCoordinatesFactory.create(Session, String, String, String, String, String, String)

createDependencyCoordinates

@Nonnull
DependencyCoordinates createDependencyCoordinates(@Nonnull
 ArtifactCoordinates coordinates)

Shortcut for getService(DependencyFactory.class).create(...).

Parameters:

coordinates - artifact coordinates to get as a dependency coordinates

Returns:

dependency coordinates for the given artifact

See Also:

• DependencyCoordinatesFactory.create(Session, ArtifactCoordinates)

createDependencyCoordinates

@Nonnull
DependencyCoordinates createDependencyCoordinates(@Nonnull
 Dependency dependency)

Shortcut for getService(DependencyFactory.class).create(...).

Parameters:

dependency - dependency for which to get the coordinates

Returns:

coordinates for the given dependency

See Also:

• DependencyCoordinatesFactory.create(Session, Dependency)

createArtifact

@Nonnull
Artifact createArtifact(String groupId,
 String artifactId,
 String version,
 String extension)

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

extension - the artifact extension, or null is unspecified

Returns:

artifact with the given coordinates

See Also:

• ArtifactFactory.create(Session, String, String, String, String)

createArtifact

@Nonnull
Artifact createArtifact(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Shortcut for getService(ArtifactFactory.class).create(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

classifier - the artifact classifier, or null is unspecified

extension - the artifact extension, or null is unspecified

type - the artifact type, or null is unspecified

Returns:

artifact with the given coordinates

See Also:

• ArtifactFactory.create(Session, String, String, String, String, String, String)

createProducedArtifact

@Nonnull
ProducedArtifact createProducedArtifact(String groupId,
 String artifactId,
 String version,
 String extension)

Shortcut for getService(ArtifactFactory.class).createProduced(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

extension - the artifact extension, or null is unspecified

Returns:

artifact with the given coordinates

See Also:

• ArtifactFactory.createProduced(Session, String, String, String, String)

createProducedArtifact

@Nonnull
ProducedArtifact createProducedArtifact(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Shortcut for getService(ArtifactFactory.class).createProduced(...).

Parameters:

groupId - the group identifier, or null is unspecified

artifactId - the artifact identifier, or null is unspecified

version - the artifact version, or null is unspecified

classifier - the artifact classifier, or null is unspecified

extension - the artifact extension, or null is unspecified

type - the artifact type, or null is unspecified

Returns:

artifact with the given coordinates

See Also:

• ArtifactFactory.createProduced(Session, String, String, String, String, String, String)

resolveArtifact

@Nonnull
DownloadedArtifact resolveArtifact(@Nonnull
 ArtifactCoordinates coordinates)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

coordinates - coordinates of the artifact to resolve

Returns:

requested artifact together with the path to its file

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

@Nonnull
DownloadedArtifact resolveArtifact(@Nonnull
 ArtifactCoordinates coordinates,
 List<RemoteRepository> repositories)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

coordinates - coordinates of the artifact to resolve

repositories - repositories to use, if null, the session repositories are used

Returns:

requested artifact together with the path to its file

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

@Nonnull
Collection<DownloadedArtifact> resolveArtifacts(@Nonnull
 ArtifactCoordinates... coordinates)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

coordinates - coordinates of all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

@Nonnull
Collection<DownloadedArtifact> resolveArtifacts(@Nonnull
 Collection<? extends ArtifactCoordinates> coordinates)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

coordinates - coordinates of all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

@Nonnull
Collection<DownloadedArtifact> resolveArtifacts(@Nonnull
 Collection<? extends ArtifactCoordinates> coordinates,
 @Nullable
 List<RemoteRepository> repositories)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

coordinates - coordinates of all artifacts to resolve

repositories - repositories to use, if null, the session repositories are used

Returns:

requested artifacts together with the paths to their files

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

@Nonnull
DownloadedArtifact resolveArtifact(@Nonnull
 Artifact artifact)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

artifact - the artifact to resolve

Returns:

requested artifact together with the path to its file

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

@Nonnull
DownloadedArtifact resolveArtifact(@Nonnull
 Artifact artifact,
 @Nullable
 List<RemoteRepository> repositories)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

artifact - the artifact to resolve

repositories - repositories to use, if null, the session repositories are used

Returns:

requested artifact together with the path to its file

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

@Nonnull
Collection<DownloadedArtifact> resolveArtifacts(@Nonnull
 Artifact... artifacts)

Shortcut for getService(ArtifactResolver.class).resolve(...).

Parameters:

artifacts - all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

installArtifacts

void installArtifacts(@Nonnull
 ProducedArtifact... artifacts)

Shortcut for getService(ArtifactInstaller.class).install(...).

Parameters:

artifacts - the artifacts to install

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

installArtifacts

void installArtifacts(@Nonnull
 Collection<ProducedArtifact> artifacts)

Shortcut for getService(ArtifactInstaller.class).install(...).

Parameters:

artifacts - the artifacts to install

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

deployArtifact

void deployArtifact(@Nonnull
 RemoteRepository repository,
 @Nonnull
 ProducedArtifact... artifacts)

Shortcut for getService(ArtifactDeployer.class).deploy(...).

Parameters:

repository - the repository where to deploy artifacts

artifacts - the artifacts to deploy

Throws:

ArtifactDeployerException - if the artifacts deployment failed

See Also:

• ArtifactDeployer.deploy(Session, RemoteRepository, Collection)

setArtifactPath

void setArtifactPath(@Nonnull
 ProducedArtifact artifact,
 @Nonnull
 Path path)

Shortcut for getService(ArtifactManager.class).setPath(...).

Parameters:

artifact - the artifact for which to associate a path

path - path to associate to the given artifact

See Also:

• ArtifactManager.setPath(ProducedArtifact, Path)

getArtifactPath

@Nonnull
Optional<Path> getArtifactPath(@Nonnull
 Artifact artifact)

Shortcut for getService(ArtifactManager.class).getPath(...).

Parameters:

artifact - the artifact for which to get a path

Returns:

path associated to the given artifact

See Also:

• ArtifactManager.getPath(Artifact)

getPathForLocalArtifact

Path getPathForLocalArtifact(@Nonnull
 Artifact artifact)

Gets the relative path for a locally installed artifact. Note that the artifact need not actually exist yet at the returned location, the path merely indicates where the artifact would eventually be stored.

Shortcut for getService(LocalArtifactManager.class).getPathForLocalArtitact(...).

Parameters:

artifact - the artifact for which to get a local path

Returns:

local path associated to the given artifact, or null if none

See Also:

• LocalRepositoryManager.getPathForLocalArtifact(Session, LocalRepository, Artifact)

getPathForRemoteArtifact

@Nonnull
Path getPathForRemoteArtifact(@Nonnull
 RemoteRepository remote,
 @Nonnull
 Artifact artifact)

Gets the relative path for an artifact cached from a remote repository. Note that the artifact need not actually exist yet at the returned location, the path merely indicates where the artifact would eventually be stored.

Shortcut for getService(LocalArtifactManager.class).getPathForRemoteArtifact(...).

Parameters:

remote - the repository from where artifacts are downloaded

artifact - the artifact for which to get a path

Returns:

path associated to the given artifact

See Also:

• LocalRepositoryManager.getPathForRemoteArtifact(Session, LocalRepository, RemoteRepository, Artifact)

isVersionSnapshot

boolean isVersionSnapshot(@Nonnull
 String version)

Checks whether a given artifact version is considered a SNAPSHOT or not.

Shortcut for getService(ArtifactManager.class).isSnapshot(...).

In case there is Artifact in scope, the recommended way to perform this check is use of Artifact.isSnapshot() instead.

Parameters:

version - artifact version

Returns:

whether the given version is a snapshot

See Also:

• VersionParser.isSnapshot(String)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 Artifact artifact,
 @Nonnull
 PathScope scope)

Shortcut for getService(DependencyResolver.class).collect(...)

Parameters:

artifact - artifact for which to get the dependencies, including transitive ones

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

root node of the dependency graph for the given artifact

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, Artifact, PathScope)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 Project project,
 @Nonnull
 PathScope scope)

Shortcut for getService(DependencyResolver.class).collect(...)

Parameters:

project - project for which to get the dependencies, including transitive ones

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

root node of the dependency graph for the given project

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, Project, PathScope)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 DependencyCoordinates dependency,
 @Nonnull
 PathScope scope)

Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the artifact files.

Shortcut for getService(DependencyResolver.class).resolve(...)

Parameters:

dependency - dependency for which to get transitive dependencies

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

root node of the dependency graph for the given artifact

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, DependencyCoordinates, PathScope)

flattenDependencies

@Nonnull
List<Node> flattenDependencies(@Nonnull
 Node node,
 @Nonnull
 PathScope scope)

Shortcut for getService(DependencyResolver.class).flatten(...).

Parameters:

node - node for which to get a flattened list

scope - build path scope (main compile, test compile, etc.) of desired nodes

Returns:

flattened list of node with the given build path scope

Throws:

DependencyResolverException - if the dependency flattening failed

See Also:

• DependencyResolver.flatten(Session, Node, PathScope)

resolveDependencies

@Nonnull
List<Path> resolveDependencies(@Nonnull
 DependencyCoordinates dependencyCoordinates)

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

Parameters:

dependencyCoordinates - coordinates of the dependency for which to get the paths

Returns:

paths to the transitive dependencies of the given dependency

See Also:

• DependencyResolver.resolve(Session, DependencyCoordinates)

resolveDependencies

@Nonnull
List<Path> resolveDependencies(@Nonnull
 List<DependencyCoordinates> dependencyCoordinates)

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

Parameters:

dependencyCoordinates - coordinates of all dependency for which to get the paths

Returns:

paths to the transitive dependencies of the given dependencies

See Also:

• DependencyResolver.resolve(Session, List)

resolveDependencies

@Nonnull
List<Path> resolveDependencies(@Nonnull
 Project project,
 @Nonnull
 PathScope scope)

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

Parameters:

project - the project for which to get dependencies

scope - build path scope (main compile, test compile, etc.) of desired paths

Returns:

paths to the transitive dependencies of the given project

See Also:

• DependencyResolver.resolve(Session, Project, PathScope)

resolveDependencies

@Nonnull
Map<PathType,List<Path>> resolveDependencies(@Nonnull
 DependencyCoordinates dependencyCoordinates,
 @Nonnull
 PathScope scope,
 @Nonnull
 Collection<PathType> desiredTypes)

Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().

Parameters:

dependencyCoordinates - coordinates of the dependency for which to get the paths

scope - build path scope (main compile, test compile, etc.) of desired paths

desiredTypes - the type of paths to include in the result

Returns:

paths to the transitive dependencies of the given project

See Also:

• DependencyResolver.resolve(Session, Project, PathScope)

resolveDependencies

@Nonnull
Map<PathType,List<Path>> resolveDependencies(@Nonnull
 Project project,
 @Nonnull
 PathScope scope,
 @Nonnull
 Collection<PathType> desiredTypes)

Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().

Parameters:

project - the project for which to get dependencies

scope - build path scope (main compile, test compile, etc.) of desired paths

desiredTypes - the type of paths to include in the result

Returns:

paths to the transitive dependencies of the given project

See Also:

• DependencyResolver.resolve(Session, Project, PathScope)

resolveVersion

@Nonnull
Version resolveVersion(@Nonnull
 ArtifactCoordinates artifact)
                throws VersionResolverException

Resolves an artifact's meta version (if any) to a concrete version. For example, resolves "1.0-SNAPSHOT" to "1.0-20090208.132618-23".

Shortcut for getService(VersionResolver.class).resolve(...)

Parameters:

artifact - the artifact for which to resolve the version

Returns:

resolved version of the given artifact

Throws:

VersionResolverException - if the resolution failed

See Also:

• (String)

resolveVersionRange

@Nonnull
List<Version> resolveVersionRange(@Nonnull
 ArtifactCoordinates artifact)
                           throws VersionResolverException

Expands a version range to a list of matching versions, in ascending order. For example, resolves "[3.8,4.0)" to "3.8", "3.8.1", "3.8.2". The returned list of versions is only dependent on the configured repositories and their contents. The supplied request may also refer to a single concrete version rather than a version range. In this case though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.

Parameters:

artifact - the artifact for which to resolve the versions

Returns:

a list of resolved Versions.

Throws:

VersionRangeResolverException - if the resolution failed

VersionResolverException

See Also:

• (String)

resolveVersionRange

@Nonnull
List<Version> resolveVersionRange(@Nonnull
 ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)
                           throws VersionResolverException

Expands a version range to a list of matching versions, in ascending order. For example, resolves "[3.8,4.0)" to "3.8", "3.8.1", "3.8.2". The returned list of versions is only dependent on the configured repositories and their contents. The supplied request may also refer to a single concrete version rather than a version range. In this case though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.

Parameters:

artifact - the artifact for which to resolve the versions

repositories - the repositories to use, or the session repositories if null

Returns:

a list of resolved Versions.

Throws:

VersionRangeResolverException - if the resolution failed

VersionResolverException

See Also:

• (String)

resolveHighestVersion

@Nonnull
Optional<Version> resolveHighestVersion(@Nonnull
 ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)
                                 throws VersionResolverException

Resolves the highest available version of a version range. The returned version is only dependent on the configured repositories and their contents. The supplied request may also refer to a single concrete version rather than a version range. In this case though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.

Parameters:

artifact - the artifact for which to resolve the versions

repositories - the repositories to use, or the session repositories if null

Returns:

the highest resolved Version.

Throws:

VersionRangeResolverException - if the resolution failed

VersionResolverException

See Also:

• (String)

parseVersion

@Nonnull
Version parseVersion(@Nonnull
 String version)

Parses the specified version string, for example "1.0".

Shortcut for getService(VersionParser.class).parseVersion(...).

Parameters:

version - the version string to parse

Returns:

the version parsed from the given string

Throws:

VersionParserException - if the parsing failed

See Also:

• VersionParser.parseVersion(String)

parseVersionRange

@Nonnull
VersionRange parseVersionRange(@Nonnull
 String versionRange)

Parses the specified version range specification, for example "[1.0,2.0)".

Shortcut for getService(VersionParser.class).parseVersionRange(...).

Parameters:

versionRange - the version string to parse

Returns:

the version range parsed from the given string

Throws:

VersionParserException - if the parsing failed

See Also:

• VersionParser.parseVersionRange(String)

parseVersionConstraint

@Nonnull
VersionConstraint parseVersionConstraint(@Nonnull
 String versionConstraint)

Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".

Shortcut for getService(VersionParser.class).parseVersionConstraint(...).

Parameters:

versionConstraint - the version string to parse

Returns:

the version constraint parsed from the given string

Throws:

VersionParserException - if the parsing failed

See Also:

• VersionParser.parseVersionConstraint(String)

requireType

@Nonnull
Type requireType(@Nonnull
 String id)

Obtain the Type from the specified id.

Shortcut for getService(TypeRegistry.class).require(...).

See Also:

• TypeRegistry.require(String)

requireLanguage

@Nonnull
Language requireLanguage(@Nonnull
 String id)

Obtain the Language from the specified id.

Shortcut for getService(LanguageRegistry.class).require(...).

See Also:

• ExtensibleEnumRegistry.require(String)

requirePackaging

@Nonnull
Packaging requirePackaging(@Nonnull
 String id)

Obtain the Packaging from the specified id.

Shortcut for getService(PackagingRegistry.class).require(...).

See Also:

• ExtensibleEnumRegistry.require(String)

requireProjectScope

@Nonnull
ProjectScope requireProjectScope(@Nonnull
 String id)

Obtain the ProjectScope from the specified id.

Shortcut for getService(ProjectScopeRegistry.class).require(...).

See Also:

• ExtensibleEnumRegistry.require(String)

requireDependencyScope

@Nonnull
DependencyScope requireDependencyScope(@Nonnull
 String id)

Obtain the DependencyScope from the specified id.

Shortcut for DependencyScope.forId(...).

See Also:

• DependencyScope.forId(String)

requirePathScope

@Nonnull
PathScope requirePathScope(@Nonnull
 String id)

Obtain the PathScope from the specified id.

Shortcut for getService(PathScopeRegistry.class).require(...).

See Also:

• ExtensibleEnumRegistry.require(String)