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

Constructor Summary

Constructors

Constructor	Description
AbstractSession()

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact)	Shortcut for getService(DependencyCollector.class).collect(...)
Node	collectDependencies(DependencyCoordinate dependency)	Shortcut for getService(DependencyCollector.class).collect(...)
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 coordString)	Shortcut for getService(CoordinateFactory.class).create(...)
ArtifactCoordinate	createArtifactCoordinate(String groupId, String artifactId, String version, String extension)	Shortcut for getService(CoordinateFactory.class).create(...)
ArtifactCoordinate	createArtifactCoordinate(String groupId, String artifactId, String version, String classifier, String extension, String type)	Shortcut for getService(CoordinateFactory.class).create(...)
ArtifactCoordinate	createArtifactCoordinate(Artifact artifact)	Shortcut for getService(CoordinateFactory.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(...).
Artifact	getArtifact(org.eclipse.aether.artifact.Artifact artifact)
Optional<Path>	getArtifactPath(Artifact artifact)	Shortcut for getService(ArtifactManager.class).getPath(...)
Dependency	getDependency(org.eclipse.aether.graph.Dependency dependency)
Collection<Listener>	getListeners()	Returns the list of registered listeners.
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.
Project	getProject(MavenProject project)
List<Project>	getProjects(List<MavenProject> projects)
RemoteRepository	getRemoteRepository(org.eclipse.aether.repository.RemoteRepository repository)
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(...)
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.
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> dependencies)
List<Path>	resolveDependencies(DependencyCoordinate dependency)
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(...)
org.eclipse.aether.artifact.Artifact	toArtifact(Artifact artifact)
org.eclipse.aether.artifact.Artifact	toArtifact(ArtifactCoordinate coord)
List<ArtifactRepository>	toArtifactRepositories(List<RemoteRepository> repositories)
abstract ArtifactRepository	toArtifactRepository(RemoteRepository repository)
List<org.eclipse.aether.artifact.Artifact>	toArtifacts(Collection<Artifact> artifacts)
List<org.eclipse.aether.graph.Dependency>	toDependencies(Collection<DependencyCoordinate> dependencies)
abstract org.eclipse.aether.graph.Dependency	toDependency(DependencyCoordinate dependency)
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.

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.internal.impl.InternalSession

getMavenSession, getRepositorySystem, getSession

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

getData, getDegreeOfConcurrency, getLocalRepository, getMavenVersion, getPluginContext, getProjects, getRemoteRepositories, getRootDirectory, getService, getSettings, getStartTime, getSystemProperties, getTopDirectory, getUserProperties, withLocalRepository, withRemoteRepositories

Constructor Details

AbstractSession

public AbstractSession()

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

getDependency

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

Specified by:

getDependency in interface InternalSession

getProjects

public List<Project> getProjects(List<MavenProject> projects)

Specified by:

getProjects in interface InternalSession

getProject

public Project getProject(MavenProject project)

Specified by:

getProject 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

toArtifactRepositories

public List<ArtifactRepository> toArtifactRepositories(List<RemoteRepository> repositories)

Specified by:

toArtifactRepositories in interface InternalSession

toArtifactRepository

public abstract ArtifactRepository toArtifactRepository(RemoteRepository repository)

Specified by:

toArtifactRepository in interface InternalSession

toDependencies

public List<org.eclipse.aether.graph.Dependency> toDependencies(Collection<DependencyCoordinate> dependencies)

Specified by:

toDependencies in interface InternalSession

toDependency

public abstract org.eclipse.aether.graph.Dependency toDependency(DependencyCoordinate dependency)

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(ArtifactCoordinate coord)

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

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

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

See Also:

• RepositoryFactory.createRemote(Repository)

createArtifactCoordinate

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

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

Specified by:

createArtifactCoordinate in interface Session

See Also:

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

createArtifactCoordinate

public ArtifactCoordinate createArtifactCoordinate(String coordString)

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

Specified by:

createArtifactCoordinate in interface Session

Parameters:

coordString - the string having "standard" coordinate.

Returns:

an ArtifactCoordinate, never null

See Also:

• ArtifactCoordinateFactory.create(Session, String)

createArtifactCoordinate

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

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

Specified by:

createArtifactCoordinate in interface Session

See Also:

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

createArtifactCoordinate

public ArtifactCoordinate createArtifactCoordinate(Artifact artifact)

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

Specified by:

createArtifactCoordinate in interface Session

See Also:

• ArtifactCoordinateFactory.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

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

See Also:

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

resolveArtifact

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

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

Specified by:

resolveArtifact in interface Session

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

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

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

Specified by:

resolveArtifacts in interface Session

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

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

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

Specified by:

resolveArtifacts in interface Session

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifact

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

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

Specified by:

resolveArtifact in interface Session

Throws:

ArtifactResolverException - if the artifact resolution failed

See Also:

• ArtifactResolver.resolve(Session, Collection)

resolveArtifacts

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

Description copied from interface: Session

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

Specified by:

resolveArtifacts in interface Session

See Also:

• ArtifactResolver.resolve(Session, Collection)

installArtifacts

public void installArtifacts(Artifact... artifacts)

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

Specified by:

installArtifacts in interface Session

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

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

Throws:

ArtifactDeployerException - if the artifacts deployment failed

See Also:

• ArtifactDeployer.deploy(Session, RemoteRepository, Collection)

setArtifactPath

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

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

Specified by:

setArtifactPath in interface Session

See Also:

• ArtifactManager.setPath(Artifact, Path)

getArtifactPath

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

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

Specified by:

getArtifactPath in interface Session

See Also:

• ArtifactManager.getPath(Artifact)

isVersionSnapshot

public boolean isVersionSnapshot(@Nonnull
 String version)

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

Specified by:

isVersionSnapshot in interface Session

See Also:

• VersionParser.isSnapshot(String)

createDependencyCoordinate

@Nonnull
public DependencyCoordinate createDependencyCoordinate(@Nonnull
 ArtifactCoordinate coordinate)

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

Specified by:

createDependencyCoordinate in interface Session

See Also:

• DependencyCoordinateFactory.create(Session, ArtifactCoordinate)

createDependencyCoordinate

@Nonnull
public DependencyCoordinate createDependencyCoordinate(@Nonnull
 Dependency dependency)

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

Specified by:

createDependencyCoordinate in interface Session

See Also:

• DependencyCoordinateFactory.create(Session, ArtifactCoordinate)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 Artifact artifact)

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

Specified by:

collectDependencies in interface Session

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, Artifact)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 Project project)

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

Specified by:

collectDependencies in interface Session

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, Project)

collectDependencies

@Nonnull
public Node collectDependencies(@Nonnull
 DependencyCoordinate dependency)

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

Specified by:

collectDependencies in interface Session

Throws:

DependencyCollectorException - if the dependency collection failed

See Also:

• DependencyCollector.collect(Session, DependencyCoordinate)

flattenDependencies

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

Description copied from interface: Session

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

Specified by:

flattenDependencies in interface Session

See Also:

• DependencyResolver.flatten(Session, Node, ResolutionScope)

resolveDependencies

public List<Path> resolveDependencies(DependencyCoordinate dependency)

Specified by:

resolveDependencies in interface Session

resolveDependencies

public List<Path> resolveDependencies(List<DependencyCoordinate> dependencies)

Specified by:

resolveDependencies in interface Session

resolveDependencies

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

Specified by:

resolveDependencies in interface Session

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

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

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

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

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

See Also:

• VersionParser.parseVersionConstraint(String)

resolveVersion

public Version resolveVersion(ArtifactCoordinate 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" or "RELEASE"/"LATEST" to "2.0".

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

Specified by:

resolveVersion in interface Session

See Also:

• (String)

resolveVersionRange

public List<Version> resolveVersionRange(ArtifactCoordinate 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

Returns:

a list of resolved Versions.

See Also:

• (String)