Package org.apache.maven.api

Interface Session

All Known Subinterfaces:

InternalSession

All Known Implementing Classes:

AbstractSession, DefaultSession

@Experimental
@ThreadSafe
public interface Session

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

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact)	Shortcut for getService(DependencyCollector.class).collect(...)
Node	collectDependencies(DependencyCoordinate dependency)	Collects the transitive dependencies of some artifacts and builds a dependency graph.
Node	collectDependencies(Project project)	Shortcut for getService(DependencyCollector.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(...).
ArtifactCoordinate	createArtifactCoordinate(String groupId, String artifactId, String version, String extension)	Shortcut for getService(ArtifactFactory.class).create(...).
ArtifactCoordinate	createArtifactCoordinate(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(ArtifactFactory.class).create(...).
ArtifactCoordinate	createArtifactCoordinate(Artifact artifact)	Shortcut for getService(ArtifactFactory.class).create(...).
DependencyCoordinate	createDependencyCoordinate(ArtifactCoordinate coordinate)	Shortcut for getService(DependencyFactory.class).create(...).
DependencyCoordinate	createDependencyCoordinate(Dependency dependency)	Shortcut for getService(DependencyFactory.class).create(...).
LocalRepository	createLocalRepository(Path path)	Shortcut for getService(RepositoryFactory.class).createLocal(...).
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, Artifact... artifacts)	Shortcut for getService(ArtifactDeployer.class).deploy(...).
List<Node>	flattenDependencies(Node node, ResolutionScope scope)	Shortcut for getService(DependencyResolver.class).flatten(...).
Optional<Path>	getArtifactPath(Artifact artifact)	Shortcut for getService(ArtifactManager.class).getPath(...).
SessionData	getData()
int	getDegreeOfConcurrency()
Collection<Listener>	getListeners()	Returns the list of registered listeners.
LocalRepository	getLocalRepository()
String	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()
List<RemoteRepository>	getRemoteRepositories()
Path	getRootDirectory()	Gets the root directory of the session, which is the root directory for the top directory project.
<T extends Service> T	getService(Class<T> clazz)	Retrieves the service for the interface
Settings	getSettings()
Instant	getStartTime()
Map<String,String>	getSystemProperties()	Gets the system properties to use for interpolation.
Path	getTopDirectory()	Gets the directory of the topmost project being built, usually the current directory or the directory pointed at by the -f/--file command line argument.
Map<String,String>	getUserProperties()	Gets the user properties to use for interpolation.
void	installArtifacts(Collection<Artifact> artifacts)	Shortcut for getService(ArtifactInstaller.class).install(...).
void	installArtifacts(Artifact... 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".
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.
Map.Entry<Artifact,Path>	resolveArtifact(Artifact artifact)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Map.Entry<Artifact,Path>	resolveArtifact(ArtifactCoordinate coordinate)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Map<Artifact,Path>	resolveArtifacts(Collection<? extends ArtifactCoordinate> coordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Map<Artifact,Path>	resolveArtifacts(Artifact... artifacts)	Shortcut for getService(ArtifactResolver.class).resolve(...).
Map<Artifact,Path>	resolveArtifacts(ArtifactCoordinate... coordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
List<Path>	resolveDependencies(List<DependencyCoordinate> dependencyCoordinates)
List<Path>	resolveDependencies(DependencyCoordinate dependencyCoordinate)
List<Path>	resolveDependencies(Project project, ResolutionScope scope)
Version	resolveVersion(ArtifactCoordinate artifact)	Resolves an artifact's meta version (if any) to a concrete version.
List<Version>	resolveVersionRange(ArtifactCoordinate artifact)	Expands a version range to a list of matching versions, in ascending order.
void	setArtifactPath(Artifact 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.

Method Details

getSettings

@Nonnull
Settings getSettings()

getLocalRepository

@Nonnull
LocalRepository getLocalRepository()

getRemoteRepositories

@Nonnull
List<RemoteRepository> getRemoteRepositories()

getData

@Nonnull
SessionData getData()

getUserProperties

@Nonnull
Map<String,String> getUserProperties()

Gets the user properties to use for interpolation. The user properties have been configured directly by the user, e.g. via the -Dkey=value parameter on the command line.

Returns:

the user properties, never null

getSystemProperties

@Nonnull
Map<String,String> getSystemProperties()

Gets the system properties to use for interpolation. The system properties are collected from the runtime environment such as System.getProperties() and environment variables.

Returns:

the system properties, never null

getMavenVersion

@Nonnull
String getMavenVersion()

Returns the current maven version

Returns:

the maven version, never null

getDegreeOfConcurrency

int getDegreeOfConcurrency()

getStartTime

@Nonnull
Instant getStartTime()

getTopDirectory

@Nonnull
Path getTopDirectory()

Gets the directory of the topmost project being built, usually the current directory or the directory pointed at by the -f/--file command line argument.

getRootDirectory

@Nonnull
Path getRootDirectory()

Gets the root directory of the session, which is the root directory for the top directory project.

Throws:

IllegalStateException - if the root directory could not be found

See Also:

• getTopDirectory()
• Project.getRootDirectory()

getProjects

@Nonnull
List<Project> getProjects()

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

LocalRepository createLocalRepository(Path path)

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

See Also:

• RepositoryFactory.createLocal(Path)

createRemoteRepository

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

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

See Also:

• RepositoryFactory.createRemote(String, String)

createRemoteRepository

@Nonnull
RemoteRepository createRemoteRepository(@Nonnull
 Repository repository)

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

See Also:

• RepositoryFactory.createRemote(Repository)

createArtifactCoordinate

ArtifactCoordinate createArtifactCoordinate(String groupId,
 String artifactId,
 String version,
 String extension)

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

See Also:

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

createArtifactCoordinate

ArtifactCoordinate createArtifactCoordinate(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

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

See Also:

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

createArtifactCoordinate

ArtifactCoordinate createArtifactCoordinate(Artifact artifact)

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

See Also:

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

createDependencyCoordinate

@Nonnull
DependencyCoordinate createDependencyCoordinate(@Nonnull
 ArtifactCoordinate coordinate)

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

See Also:

• DependencyCoordinateFactory.create(Session, ArtifactCoordinate)

createDependencyCoordinate

@Nonnull
DependencyCoordinate createDependencyCoordinate(@Nonnull
 Dependency dependency)

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

See Also:

• DependencyCoordinateFactory.create(Session, Dependency)

createArtifact

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

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

See Also:

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

createArtifact

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

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

See Also:

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

resolveArtifact

Map.Entry<Artifact,Path> resolveArtifact(ArtifactCoordinate coordinate)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

Map<Artifact,Path> resolveArtifacts(ArtifactCoordinate... coordinates)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

Map<Artifact,Path> resolveArtifacts(Collection<? extends ArtifactCoordinate> coordinates)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

Map.Entry<Artifact,Path> resolveArtifact(Artifact artifact)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

Map<Artifact,Path> resolveArtifacts(Artifact... artifacts)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

installArtifacts

void installArtifacts(Artifact... artifacts)

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

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

installArtifacts

void installArtifacts(Collection<Artifact> artifacts)

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

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

deployArtifact

void deployArtifact(RemoteRepository repository,
 Artifact... artifacts)

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

Throws:

ArtifactDeployerException - if the artifacts deployment failed

See Also:

• ArtifactDeployer.deploy(Session, RemoteRepository, Collection)

setArtifactPath

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

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

See Also:

• ArtifactManager.setPath(Artifact, Path)

getArtifactPath

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

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

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(...).

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(...).

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(...).

See Also:

• VersionParser.isSnapshot(String)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 Artifact artifact)

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

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, Artifact)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 Project project)

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

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, Project)

collectDependencies

@Nonnull
Node collectDependencies(@Nonnull
 DependencyCoordinate dependency)

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(DependencyCollector.class).resolve(...)

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, DependencyCoordinate)

flattenDependencies

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

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

Throws:

DependencyResolverException - if the dependency flattening failed

See Also:

• DependencyResolver.flatten(Session, Node, ResolutionScope)

resolveDependencies

@Nonnull
List<Path> resolveDependencies(@Nonnull
 DependencyCoordinate dependencyCoordinate)

resolveDependencies

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

resolveDependencies

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

resolveVersion

@Nonnull
Version resolveVersion(@Nonnull
 ArtifactCoordinate artifact)

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

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

Throws:

VersionResolverException - if the resolution failed

See Also:

• (String)

resolveVersionRange

@Nonnull
List<Version> resolveVersionRange(@Nonnull
 ArtifactCoordinate artifact)

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.

Returns:

a list of resolved Versions.

Throws:

VersionRangeResolverException - if the resolution failed

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(...).

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(...).

Throws:

VersionParserException - if the parsing failed

See Also:

• VersionParser.parseVersionRange(String)