Class SessionStub

java.lang.Object

org.apache.maven.api.plugin.testing.stubs.SessionStub

All Implemented Interfaces:

ProtoSession, Session

public class SessionStub
extends Object
implements Session

A stub implementation of Session for basic testing scenarios. Provides minimal implementation of session methods without mock dependencies.

For more comprehensive session mocking, consider using SessionMock instead.

Since:

4.0.0

See Also:

• SessionMock

Nested Class Summary

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

ProtoSession.Builder

Constructor Summary

Constructors

Constructor	Description
SessionStub()
SessionStub(Map<String,String> userProperties)
SessionStub(Map<String,String> systemProperties, Map<String,String> userProperties, Settings settings)
SessionStub(Settings settings)

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact, PathScope scope)	Shortcut for getService(DependencyResolver.class).collect(...)
Node	collectDependencies(DependencyCoordinates dependencyCoordinates, 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 coordString)	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 artifactCoordinates)	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.
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()	Retrieves the settings for the current session.
Instant	getStartTime()	Returns the start time of the session.
Map<String,String>	getSystemProperties()	Returns immutable system properties to use for interpolation.
Collection<ToolchainModel>	getToolchains()	Retrieves toolchain models that have been explicitly configured.
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()	Returns immutable user properties to use for interpolation.
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 s)	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 coordinate)	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> collection)	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... artifactCoordinates)	Shortcut for getService(ArtifactResolver.class).resolve(...).
List<Path>	resolveDependencies(List<DependencyCoordinates> dependencyCoordinatess)	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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

toBuilder

Constructor Details

SessionStub

public SessionStub(Settings settings)

SessionStub

public SessionStub()

SessionStub

public SessionStub(Map<String,String> userProperties)

SessionStub

public SessionStub(Map<String,String> systemProperties,
 Map<String,String> userProperties,
 Settings settings)

Method Details

getSettings

public Settings getSettings()

Description copied from interface: Session

Retrieves the settings for the current session.

Specified by:

getSettings in interface Session

Returns:

the settings instance

getSystemProperties

public Map<String,String> getSystemProperties()

Description copied from interface: ProtoSession

Returns immutable system properties to use for interpolation. The system properties are collected from the runtime environment such as System.getProperties() and environment variables (prefixed with env.).

Specified by:

getSystemProperties in interface ProtoSession

Returns:

the system properties, never null

getUserProperties

public Map<String,String> getUserProperties()

Description copied from interface: ProtoSession

Returns immutable 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.

Specified by:

getUserProperties in interface ProtoSession

Returns:

the user properties, never null

getEffectiveProperties

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

Description copied from interface: Session

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.

Specified by:

getEffectiveProperties in interface Session

Parameters:

project - Project or null.

Returns:

the effective properties, never null

getLocalRepository

public LocalRepository getLocalRepository()

Description copied from interface: Session

Retrieves the local repository associated with this session.

Specified by:

getLocalRepository in interface Session

Returns:

the local repository instance

getTopDirectory

public Path getTopDirectory()

Description copied from interface: ProtoSession

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.

Specified by:

getTopDirectory in interface ProtoSession

Returns:

the directory of the topmost project, never null

See Also:

• Project.isTopProject()
• ProtoSession.getRootDirectory()

getRootDirectory

public Path getRootDirectory()

Description copied from interface: ProtoSession

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

Specified by:

getRootDirectory in interface ProtoSession

Returns:

the root directory, never null

See Also:

• ProtoSession.getTopDirectory()
• Project.getRootDirectory()
• Project.isRootProject()

getRemoteRepositories

public List<RemoteRepository> getRemoteRepositories()

Description copied from interface: Session

Retrieves a list of remote repositories associated with this session.

Specified by:

getRemoteRepositories in interface Session

Returns:

a list of remote repositories

getData

public SessionData getData()

Description copied from interface: Session

Retrieves the session data associated with this session.

Specified by:

getData in interface Session

Returns:

the session data, never null

getMavenVersion

public Version getMavenVersion()

Description copied from interface: Session

Returns the current maven version.

Specified by:

getMavenVersion in interface Session

Returns:

the maven version, never null

getDegreeOfConcurrency

public int getDegreeOfConcurrency()

Description copied from interface: Session

Returns the degree of concurrency for the build.

Specified by:

getDegreeOfConcurrency in interface Session

Returns:

the degree of concurrency

getStartTime

public Instant getStartTime()

Description copied from interface: ProtoSession

Returns the start time of the session.

Specified by:

getStartTime in interface ProtoSession

Returns:

the start time as an Instant object, never null

getProjects

public List<Project> getProjects()

Description copied from interface: Session

Retrieves a list of projects associated with the session.

Specified by:

getProjects in interface Session

Returns:

a list of projects, never null

getPluginContext

public Map<String,Object> getPluginContext(Project project)

Description copied from interface: Session

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.

Specified by:

getPluginContext in interface Session

getService

public <T extends Service> T getService(Class<T> clazz)

Description copied from interface: Session

Retrieves the service for the interface

Specified by:

getService in interface Session

withLocalRepository

public Session withLocalRepository(LocalRepository localRepository)

Description copied from interface: Session

Creates a derived session using the given local repository.

Specified by:

withLocalRepository in interface Session

Parameters:

localRepository - the new local repository

Returns:

the derived session

withRemoteRepositories

public Session withRemoteRepositories(List<RemoteRepository> repositories)

Description copied from interface: Session

Creates a derived session using the given remote repositories.

Specified by:

withRemoteRepositories in interface Session

Parameters:

repositories - the new list of remote repositories

Returns:

the derived session

registerListener

public void registerListener(Listener listener)

Description copied from interface: Session

Register the given listener which will receive all events.

Specified by:

registerListener in interface Session

Parameters:

listener - the listener to register

unregisterListener

public void unregisterListener(Listener listener)

Description copied from interface: Session

Unregisters a previously registered listener.

Specified by:

unregisterListener in interface Session

Parameters:

listener - the listener to unregister

getListeners

public Collection<Listener> getListeners()

Description copied from interface: Session

Returns the list of registered listeners.

Specified by:

getListeners in interface Session

Returns:

an immutable collection of listeners, never null

createLocalRepository

public LocalRepository createLocalRepository(Path path)

Description copied from interface: Session

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

Specified by:

createLocalRepository in interface Session

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

public RemoteRepository createRemoteRepository(String id,
 String url)

Description copied from interface: Session

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

Specified by:

createRemoteRepository in interface Session

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

public RemoteRepository createRemoteRepository(Repository repository)

Description copied from interface: Session

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

Specified by:

createRemoteRepository in interface Session

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)

createArtifact

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

Description copied from interface: Session

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

Specified by:

createArtifact in interface Session

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

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

Description copied from interface: Session

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

Specified by:

createArtifact in interface Session

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

public ProducedArtifact createProducedArtifact(String groupId,
 String artifactId,
 String version,
 String extension)

Description copied from interface: Session

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

Specified by:

createProducedArtifact in interface Session

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

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

Description copied from interface: Session

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

Specified by:

createProducedArtifact in interface Session

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)

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(String groupId,
 String artifactId,
 String version,
 String extension)

Description copied from interface: Session

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

Specified by:

createArtifactCoordinates in interface Session

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

public ArtifactCoordinates createArtifactCoordinates(String coordString)

Description copied from interface: Session

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

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

Specified by:

createArtifactCoordinates in interface Session

Parameters:

coordString - the string having "standard" coordinates.

Returns:

coordinates used to point to the artifact

See Also:

• ArtifactCoordinatesFactory.create(Session, String)

createArtifactCoordinates

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

Description copied from interface: Session

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

Specified by:

createArtifactCoordinates in interface Session

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

public ArtifactCoordinates createArtifactCoordinates(Artifact artifact)

Description copied from interface: Session

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

Specified by:

createArtifactCoordinates in interface Session

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

public DependencyCoordinates createDependencyCoordinates(ArtifactCoordinates artifactCoordinates)

Description copied from interface: Session

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

Specified by:

createDependencyCoordinates in interface Session

Parameters:

artifactCoordinates - artifact coordinates to get as a dependency coordinates

Returns:

dependency coordinates for the given artifact

See Also:

• DependencyCoordinatesFactory.create(Session, ArtifactCoordinates)

createDependencyCoordinates

public DependencyCoordinates createDependencyCoordinates(Dependency dependency)

Description copied from interface: Session

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

Specified by:

createDependencyCoordinates in interface Session

Parameters:

dependency - dependency for which to get the coordinates

Returns:

coordinates for the given dependency

See Also:

• DependencyCoordinatesFactory.create(Session, Dependency)

resolveArtifact

public DownloadedArtifact resolveArtifact(Artifact artifact)

Description copied from interface: Session

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

Specified by:

resolveArtifact in interface Session

Parameters:

artifact - the artifact to resolve

Returns:

requested artifact together with the path to its file

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

public DownloadedArtifact resolveArtifact(ArtifactCoordinates coordinate)

Description copied from interface: Session

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

Specified by:

resolveArtifact in interface Session

Parameters:

coordinate - coordinates of the artifact to resolve

Returns:

requested artifact together with the path to its file

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

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

Description copied from interface: Session

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

Specified by:

resolveArtifact in interface Session

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

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

public DownloadedArtifact resolveArtifact(Artifact artifact,
 List<RemoteRepository> repositories)

Description copied from interface: Session

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

Specified by:

resolveArtifact in interface Session

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

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(ArtifactCoordinates... artifactCoordinates)

Description copied from interface: Session

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

Specified by:

resolveArtifacts in interface Session

Parameters:

artifactCoordinates - coordinates of all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> collection)

Description copied from interface: Session

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

Specified by:

resolveArtifacts in interface Session

Parameters:

collection - coordinates of all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Artifact... artifacts)

Description copied from interface: Session

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

Specified by:

resolveArtifacts in interface Session

Parameters:

artifacts - all artifacts to resolve

Returns:

requested artifacts together with the paths to their files

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates,
 List<RemoteRepository> repositories)

Description copied from interface: Session

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

Specified by:

resolveArtifacts in interface Session

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

See Also:

• ArtifactResolver.resolve(Session, Collection)

flattenDependencies

public List<Node> flattenDependencies(Node node,
 PathScope scope)

Description copied from interface: Session

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

Specified by:

flattenDependencies in interface Session

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

See Also:

• DependencyResolver.flatten(Session, Node, PathScope)

resolveDependencies

public List<Path> resolveDependencies(DependencyCoordinates dependencyCoordinates)

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

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

public List<Path> resolveDependencies(List<DependencyCoordinates> dependencyCoordinatess)

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

Parameters:

dependencyCoordinatess - 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

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

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

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)

resolveVersion

public Version resolveVersion(ArtifactCoordinates artifact)

Description copied from interface: Session

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

Specified by:

resolveVersion in interface Session

Parameters:

artifact - the artifact for which to resolve the version

Returns:

resolved version of the given artifact

See Also:

• (String)

resolveVersionRange

public List<Version> resolveVersionRange(ArtifactCoordinates artifact)

Description copied from interface: Session

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.

Specified by:

resolveVersionRange in interface Session

Parameters:

artifact - the artifact for which to resolve the versions

Returns:

a list of resolved Versions.

See Also:

• (String)

resolveVersionRange

public List<Version> resolveVersionRange(ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)

Description copied from interface: Session

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.

Specified by:

resolveVersionRange in interface Session

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.

See Also:

• (String)

installArtifacts

public void installArtifacts(ProducedArtifact... artifacts)

Description copied from interface: Session

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

Specified by:

installArtifacts in interface Session

Parameters:

artifacts - the artifacts to install

See Also:

• ArtifactInstaller.install(Session, Collection)

installArtifacts

public void installArtifacts(Collection<ProducedArtifact> artifacts)

Description copied from interface: Session

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

Specified by:

installArtifacts in interface Session

Parameters:

artifacts - the artifacts to install

See Also:

• ArtifactInstaller.install(Session, Collection)

deployArtifact

public void deployArtifact(RemoteRepository repository,
 ProducedArtifact... artifacts)

Description copied from interface: Session

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

Specified by:

deployArtifact in interface Session

Parameters:

repository - the repository where to deploy artifacts

artifacts - the artifacts to deploy

See Also:

• ArtifactDeployer.deploy(Session, RemoteRepository, Collection)

setArtifactPath

public void setArtifactPath(ProducedArtifact artifact,
 Path path)

Description copied from interface: Session

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

Specified by:

setArtifactPath in interface Session

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

public Optional<Path> getArtifactPath(Artifact artifact)

Description copied from interface: Session

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

Specified by:

getArtifactPath in interface Session

Parameters:

artifact - the artifact for which to get a path

Returns:

path associated to the given artifact

See Also:

• ArtifactManager.getPath(Artifact)

isVersionSnapshot

public boolean isVersionSnapshot(String version)

Description copied from interface: Session

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.

Specified by:

isVersionSnapshot in interface Session

Parameters:

version - artifact version

Returns:

whether the given version is a snapshot

See Also:

• VersionParser.isSnapshot(String)

collectDependencies

public Node collectDependencies(Artifact artifact,
 PathScope scope)

Description copied from interface: Session

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

Specified by:

collectDependencies in interface Session

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

See Also:

• DependencyResolver.collect(Session, Artifact, PathScope)

collectDependencies

public Node collectDependencies(Project project,
 PathScope scope)

Description copied from interface: Session

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

Specified by:

collectDependencies in interface Session

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

See Also:

• DependencyResolver.collect(Session, Project, PathScope)

collectDependencies

public Node collectDependencies(DependencyCoordinates dependencyCoordinates,
 PathScope scope)

Description copied from interface: Session

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

Specified by:

collectDependencies in interface Session

Parameters:

dependencyCoordinates - 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

See Also:

• DependencyResolver.collect(Session, DependencyCoordinates, PathScope)

getPathForLocalArtifact

public Path getPathForLocalArtifact(Artifact artifact)

Description copied from interface: Session

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

Specified by:

getPathForLocalArtifact in interface Session

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

public Path getPathForRemoteArtifact(RemoteRepository remote,
 Artifact artifact)

Description copied from interface: Session

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

Specified by:

getPathForRemoteArtifact in interface Session

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)

parseVersion

public Version parseVersion(String version)

Description copied from interface: Session

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

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

Specified by:

parseVersion in interface Session

Parameters:

version - the version string to parse

Returns:

the version parsed from the given string

See Also:

• VersionParser.parseVersion(String)

parseVersionRange

public VersionRange parseVersionRange(String versionRange)

Description copied from interface: Session

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

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

Specified by:

parseVersionRange in interface Session

Parameters:

versionRange - the version string to parse

Returns:

the version range parsed from the given string

See Also:

• VersionParser.parseVersionRange(String)

parseVersionConstraint

public VersionConstraint parseVersionConstraint(String s)

Description copied from interface: Session

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

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

Specified by:

parseVersionConstraint in interface Session

Parameters:

s - the version string to parse

Returns:

the version constraint parsed from the given string

See Also:

• VersionParser.parseVersionConstraint(String)

resolveDependencies

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

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

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

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

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

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)

requireType

public Type requireType(String id)

Description copied from interface: Session

Obtain the Type from the specified id.

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

Specified by:

requireType in interface Session

See Also:

• TypeRegistry.require(String)

requireLanguage

public Language requireLanguage(String id)

Description copied from interface: Session

Obtain the Language from the specified id.

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

Specified by:

requireLanguage in interface Session

See Also:

• ExtensibleEnumRegistry.require(String)

requirePackaging

public Packaging requirePackaging(String id)

Description copied from interface: Session

Obtain the Packaging from the specified id.

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

Specified by:

requirePackaging in interface Session

See Also:

• ExtensibleEnumRegistry.require(String)

requireProjectScope

public ProjectScope requireProjectScope(String id)

Description copied from interface: Session

Obtain the ProjectScope from the specified id.

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

Specified by:

requireProjectScope in interface Session

See Also:

• ExtensibleEnumRegistry.require(String)

requireDependencyScope

public DependencyScope requireDependencyScope(String id)

Description copied from interface: Session

Obtain the DependencyScope from the specified id.

Shortcut for DependencyScope.forId(...) with a verification that the given identifier exists.

Specified by:

requireDependencyScope in interface Session

Parameters:

id - the identifier of the scope (case-sensitive)

Returns:

the scope for the given identifier (never null)

See Also:

• DependencyScope.forId(String)

requirePathScope

public PathScope requirePathScope(String id)

Description copied from interface: Session

Obtain the PathScope from the specified id.

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

Specified by:

requirePathScope in interface Session

See Also:

• ExtensibleEnumRegistry.require(String)

resolveHighestVersion

public Optional<Version> resolveHighestVersion(ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)

Description copied from interface: Session

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.

Specified by:

resolveHighestVersion in interface Session

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.

See Also:

• (String)

getToolchains

public Collection<ToolchainModel> getToolchains()

Description copied from interface: Session

Retrieves toolchain models that have been explicitly configured.

Specified by:

getToolchains in interface Session

Returns:

the toolchain models