Package org.apache.maven.internal.impl

Class AbstractSession

java.lang.Object

org.apache.maven.internal.impl.AbstractSession

All Implemented Interfaces:

Session, InternalSession

Direct Known Subclasses:

DefaultSession

public abstract class AbstractSession
extends Object
implements InternalSession

Field Summary

Fields

Modifier and Type	Field	Description
protected final Lookup	lookup
protected final List<RemoteRepository>	repositories
protected final org.eclipse.aether.RepositorySystem	repositorySystem
protected final org.eclipse.aether.RepositorySystemSession	session

Constructor Summary

Constructors

Constructor	Description
AbstractSession(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.RepositorySystem repositorySystem, List<RemoteRepository> repositories, List<org.eclipse.aether.repository.RemoteRepository> resolverRepositories, Lookup lookup)

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact)	Shortcut for getService(DependencyResolver.class).collect(...)
Node	collectDependencies(DependencyCoordinates dependency)	Shortcut for getService(DependencyResolver.class).collect(...)
Node	collectDependencies(Project project)	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)	Shortcut for getService(ArtifactCoordinatesFactory.class).create(...)
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String extension)	Shortcut for getService(ArtifactCoordinatesFactory.class).create(...)
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(ArtifactCoordinatesFactory.class).create(...)
ArtifactCoordinates	createArtifactCoordinates(Artifact artifact)	Shortcut for getService(ArtifactCoordinatesFactory.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, Artifact... artifacts)	Shortcut for getService(ArtifactDeployer.class).deploy(...)
List<Node>	flattenDependencies(Node node, PathScope scope)	Shortcut for getService(DependencyResolver.class).flatten(...).
<T extends Artifact> T	getArtifact(Class<T> clazz, org.eclipse.aether.artifact.Artifact artifact)
Artifact	getArtifact(org.eclipse.aether.artifact.Artifact artifact)
Optional<Path>	getArtifactPath(Artifact artifact)	Shortcut for getService(ArtifactManager.class).getPath(...)
SessionData	getData()	Retrieves the session data associated with this session.
Dependency	getDependency(org.eclipse.aether.graph.Dependency dependency)
Collection<Listener>	getListeners()	Returns the list of registered listeners.
LocalRepository	getLocalRepository()	Retrieves the local repository associated with this session.
Node	getNode(org.eclipse.aether.graph.DependencyNode node)
Node	getNode(org.eclipse.aether.graph.DependencyNode node, boolean verbose)
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.
List<RemoteRepository>	getRemoteRepositories()	Retrieves a list of remote repositories associated with this session.
RemoteRepository	getRemoteRepository(org.eclipse.aether.repository.RemoteRepository repository)
org.eclipse.aether.RepositorySystem	getRepositorySystem()
<T extends Service> T	getService(Class<T> clazz)	Retrieves the service for the interface
org.eclipse.aether.RepositorySystemSession	getSession()
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)	Shortcut for getService(VersionParser.class).isSnapshot(...)
protected abstract Session	newSession(org.eclipse.aether.RepositorySystemSession session, List<RemoteRepository> repositories)
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(...)
Collection<DownloadedArtifact>	resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates)	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> dependencies)	Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().
List<Path>	resolveDependencies(DependencyCoordinates dependency)	Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().
Map<PathType,List<Path>>	resolveDependencies(DependencyCoordinates dependency, 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().
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.
void	setArtifactPath(ProducedArtifact artifact, Path path)	Shortcut for getService(ArtifactManager.class).setPath(...)
org.eclipse.aether.artifact.Artifact	toArtifact(Artifact artifact)
org.eclipse.aether.artifact.Artifact	toArtifact(ArtifactCoordinates coords)
List<org.eclipse.aether.artifact.Artifact>	toArtifacts(Collection<Artifact> artifacts)
List<org.eclipse.aether.graph.Dependency>	toDependencies(Collection<DependencyCoordinates> dependencies, boolean managed)
org.eclipse.aether.graph.Dependency	toDependency(DependencyCoordinates dependency, boolean managed)
List<org.eclipse.aether.repository.RemoteRepository>	toRepositories(List<RemoteRepository> repositories)
org.eclipse.aether.repository.LocalRepository	toRepository(LocalRepository repository)
org.eclipse.aether.repository.RemoteRepository	toRepository(RemoteRepository repository)
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.Session

getDegreeOfConcurrency, getEffectiveProperties, getMavenVersion, getPluginContext, getProjects, getRootDirectory, getSettings, getStartTime, getSystemProperties, getTopDirectory, getUserProperties

Field Details

session

protected final org.eclipse.aether.RepositorySystemSession session

repositorySystem

protected final org.eclipse.aether.RepositorySystem repositorySystem

repositories

protected final List<RemoteRepository> repositories

lookup

protected final Lookup lookup

Constructor Details

AbstractSession

public AbstractSession(org.eclipse.aether.RepositorySystemSession session,
 org.eclipse.aether.RepositorySystem repositorySystem,
 List<RemoteRepository> repositories,
 List<org.eclipse.aether.repository.RemoteRepository> resolverRepositories,
 Lookup lookup)

Method Details

getRemoteRepository

public RemoteRepository getRemoteRepository(org.eclipse.aether.repository.RemoteRepository repository)

Specified by:

getRemoteRepository in interface InternalSession

getNode

public Node getNode(org.eclipse.aether.graph.DependencyNode node)

Specified by:

getNode in interface InternalSession

getNode

public Node getNode(org.eclipse.aether.graph.DependencyNode node,
 boolean verbose)

Specified by:

getNode in interface InternalSession

getArtifact

@Nonnull
public Artifact getArtifact(@Nonnull
 org.eclipse.aether.artifact.Artifact artifact)

Specified by:

getArtifact in interface InternalSession

getArtifact

public <T extends Artifact> T getArtifact(Class<T> clazz,
 org.eclipse.aether.artifact.Artifact artifact)

Specified by:

getArtifact in interface InternalSession

getDependency

@Nonnull
public Dependency getDependency(@Nonnull
 org.eclipse.aether.graph.Dependency dependency)

Specified by:

getDependency in interface InternalSession

toRepositories

public List<org.eclipse.aether.repository.RemoteRepository> toRepositories(List<RemoteRepository> repositories)

Specified by:

toRepositories in interface InternalSession

toRepository

public org.eclipse.aether.repository.RemoteRepository toRepository(RemoteRepository repository)

Specified by:

toRepository in interface InternalSession

toRepository

public org.eclipse.aether.repository.LocalRepository toRepository(LocalRepository repository)

Specified by:

toRepository in interface InternalSession

toDependencies

public List<org.eclipse.aether.graph.Dependency> toDependencies(Collection<DependencyCoordinates> dependencies,
 boolean managed)

Specified by:

toDependencies in interface InternalSession

getRemoteRepositories

@Nonnull
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

@Nonnull
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

getLocalRepository

@Nonnull
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

withLocalRepository

@Nonnull
public Session withLocalRepository(@Nonnull
 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

@Nonnull
public Session withRemoteRepositories(@Nonnull
 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

newSession

protected abstract Session newSession(org.eclipse.aether.RepositorySystemSession session,
 List<RemoteRepository> repositories)

getService

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

Description copied from interface: Session

Retrieves the service for the interface

Specified by:

getService in interface Session

Throws:

NoSuchElementException - if the service could not be found

getSession

@Nonnull
public org.eclipse.aether.RepositorySystemSession getSession()

Specified by:

getSession in interface InternalSession

getRepositorySystem

@Nonnull
public org.eclipse.aether.RepositorySystem getRepositorySystem()

Specified by:

getRepositorySystem in interface InternalSession

toDependency

public org.eclipse.aether.graph.Dependency toDependency(DependencyCoordinates dependency,
 boolean managed)

Specified by:

toDependency in interface InternalSession

toArtifacts

public List<org.eclipse.aether.artifact.Artifact> toArtifacts(Collection<Artifact> artifacts)

Specified by:

toArtifacts in interface InternalSession

toArtifact

public org.eclipse.aether.artifact.Artifact toArtifact(Artifact artifact)

Specified by:

toArtifact in interface InternalSession

toArtifact

public org.eclipse.aether.artifact.Artifact toArtifact(ArtifactCoordinates coords)

Specified by:

toArtifact in interface InternalSession

registerListener

public void registerListener(@Nonnull
 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(@Nonnull
 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

@Nonnull
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)

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

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

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

@Nonnull
public RemoteRepository createRemoteRepository(@Nonnull
 Repository repository)

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)

createArtifactCoordinates

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

Shortcut for getService(ArtifactCoordinatesFactory.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:

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

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(String coordString)

Shortcut for getService(ArtifactCoordinatesFactory.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)

Shortcut for getService(ArtifactCoordinatesFactory.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)

Shortcut for getService(ArtifactCoordinatesFactory.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)

createArtifact

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

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)

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)

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)

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)

resolveArtifact

public DownloadedArtifact resolveArtifact(ArtifactCoordinates coordinates)

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

Specified by:

resolveArtifact in interface Session

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)

resolveArtifacts

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

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

Specified by:

resolveArtifacts in interface Session

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

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

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

Specified by:

resolveArtifacts in interface Session

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)

resolveArtifact

public DownloadedArtifact resolveArtifact(Artifact artifact)

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

Throws:

ArtifactResolverException - if the artifact resolution failed

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)

installArtifacts

public void installArtifacts(Artifact... artifacts)

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

Specified by:

installArtifacts in interface Session

Parameters:

artifacts - the artifacts to install

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

installArtifacts

public void installArtifacts(Collection<Artifact> artifacts)

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

Specified by:

installArtifacts in interface Session

Parameters:

artifacts - the artifacts to install

Throws:

ArtifactInstallerException - if the artifacts installation failed

See Also:

• ArtifactInstaller.install(Session, Collection)

deployArtifact

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

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

Throws:

ArtifactDeployerException - if the artifacts deployment failed

See Also:

• ArtifactDeployer.deploy(Session, RemoteRepository, Collection)

setArtifactPath

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

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

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

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(@Nonnull
 String version)

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

Specified by:

isVersionSnapshot in interface Session

Parameters:

version - artifact version

Returns:

whether the given version is a snapshot

See Also:

• VersionParser.isSnapshot(String)

createDependencyCoordinates

@Nonnull
public DependencyCoordinates createDependencyCoordinates(@Nonnull
 ArtifactCoordinates coordinates)

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

Specified by:

createDependencyCoordinates in interface Session

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
public DependencyCoordinates createDependencyCoordinates(@Nonnull
 Dependency dependency)

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, ArtifactCoordinates)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 Artifact artifact)

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

Specified by:

collectDependencies in interface Session

Parameters:

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

Returns:

root node of the dependency graph for the given artifact

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, Artifact)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 Project project)

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

Specified by:

collectDependencies in interface Session

Parameters:

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

Returns:

root node of the dependency graph for the given project

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, Project)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 DependencyCoordinates dependency)

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

Specified by:

collectDependencies in interface Session

Parameters:

dependency - dependency for which to get transitive dependencies

Returns:

root node of the dependency graph for the given artifact

Throws:

DependencyResolverException - if the dependency collection failed

See Also:

• DependencyResolver.collect(Session, DependencyCoordinates)

flattenDependencies

@Nonnull
public List<Node> flattenDependencies(@Nonnull
 Node node,
 @Nonnull
 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 dependency)

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

Parameters:

dependency - 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> dependencies)

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

Parameters:

dependencies - 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)

resolveDependencies

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

Description copied from interface: Session

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

Specified by:

resolveDependencies in interface Session

Parameters:

dependency - 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(@Nonnull
 Project project,
 @Nonnull
 PathScope scope,
 @Nonnull
 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)

getPathForLocalArtifact

public Path getPathForLocalArtifact(@Nonnull
 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 versionConstraint)

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:

versionConstraint - the version string to parse

Returns:

the version constraint parsed from the given string

See Also:

• VersionParser.parseVersionConstraint(String)

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)

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

Specified by:

requireDependencyScope in interface Session

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)