Package org.apache.maven.internal.impl
Class AbstractSession
java.lang.Object
org.apache.maven.internal.impl.AbstractSession
- All Implemented Interfaces:
ProtoSession
,Session
,InternalSession
- Direct Known Subclasses:
DefaultSession
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.maven.api.ProtoSession
ProtoSession.Builder
-
Field Summary
Modifier and TypeFieldDescriptionprotected final Lookup
protected final List<RemoteRepository>
protected final org.eclipse.aether.RepositorySystem
protected final org.eclipse.aether.RepositorySystemSession
-
Constructor Summary
ConstructorDescriptionAbstractSession
(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 TypeMethodDescriptioncollectDependencies
(Artifact artifact, PathScope scope) Shortcut forgetService(DependencyResolver.class).collect(...)
collectDependencies
(DependencyCoordinates dependency, PathScope scope) Shortcut forgetService(DependencyResolver.class).collect(...)
collectDependencies
(Project project, PathScope scope) Shortcut forgetService(DependencyResolver.class).collect(...)
createArtifact
(String groupId, String artifactId, String version, String extension) Shortcut forgetService(ArtifactFactory.class).create(...)
createArtifact
(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactFactory.class).create(...)
createArtifactCoordinates
(String coordString) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
createArtifactCoordinates
(String groupId, String artifactId, String version, String extension) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
createArtifactCoordinates
(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
createArtifactCoordinates
(Artifact artifact) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
createDependencyCoordinates
(ArtifactCoordinates coordinates) Shortcut forgetService(DependencyFactory.class).create(...)
createDependencyCoordinates
(Dependency dependency) Shortcut forgetService(DependencyFactory.class).create(...)
createLocalRepository
(Path path) Shortcut forgetService(RepositoryFactory.class).createLocal(...)
createProducedArtifact
(String groupId, String artifactId, String version, String extension) Shortcut forgetService(ArtifactFactory.class).createProduced(...)
createProducedArtifact
(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactFactory.class).createProduced(...)
createRemoteRepository
(String id, String url) Shortcut forgetService(RepositoryFactory.class).createRemote(...)
createRemoteRepository
(Repository repository) Shortcut forgetService(RepositoryFactory.class).createRemote(...)
void
deployArtifact
(RemoteRepository repository, ProducedArtifact... artifacts) Shortcut forgetService(ArtifactDeployer.class).deploy(...)
flattenDependencies
(Node node, PathScope scope) Shortcut forgetService(DependencyResolver.class).flatten(...)
.<T extends Artifact>
TgetArtifact
(Class<T> clazz, org.eclipse.aether.artifact.Artifact artifact) getArtifact
(org.eclipse.aether.artifact.Artifact artifact) getArtifactPath
(Artifact artifact) Shortcut forgetService(ArtifactManager.class).getPath(...)
getData()
Retrieves the session data associated with this session.getDependency
(org.eclipse.aether.graph.Dependency dependency) Returns the list of registered listeners.Retrieves the local repository associated with this session.getNode
(org.eclipse.aether.graph.DependencyNode node) getNode
(org.eclipse.aether.graph.DependencyNode node, boolean verbose) getPathForLocalArtifact
(Artifact artifact) Gets the relative path for a locally installed artifact.getPathForRemoteArtifact
(RemoteRepository remote, Artifact artifact) Gets the relative path for an artifact cached from a remote repository.Retrieves a list of remote repositories associated with this session.getRemoteRepository
(org.eclipse.aether.repository.RemoteRepository repository) org.eclipse.aether.RepositorySystem
<T extends Service>
TgetService
(Class<T> clazz) Retrieves the service for the interfaceorg.eclipse.aether.RepositorySystemSession
void
installArtifacts
(Collection<ProducedArtifact> artifacts) Shortcut forgetService(ArtifactInstaller.class).install(...)
void
installArtifacts
(ProducedArtifact... artifacts) Shortcut forgetService(ArtifactInstaller.class).install(...)
boolean
isVersionSnapshot
(String version) Shortcut forgetService(VersionParser.class).isSnapshot(...)
protected abstract Session
newSession
(org.eclipse.aether.RepositorySystemSession session, List<RemoteRepository> repositories) parseVersion
(String version) Parses the specified version string, for example "1.0".parseVersionConstraint
(String versionConstraint) Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".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.Obtain theDependencyScope
from the specifiedid
.Obtain theLanguage
from the specifiedid
.Obtain thePackaging
from the specifiedid
.Obtain thePathScope
from the specifiedid
.Obtain theProjectScope
from the specifiedid
.requireType
(String id) Obtain theType
from the specifiedid
.resolveArtifact
(Artifact artifact) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifact
(ArtifactCoordinates coordinates) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifact
(ArtifactCoordinates coordinates, List<RemoteRepository> repositories) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifact
(Artifact artifact, List<RemoteRepository> repositories) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifacts
(Collection<? extends ArtifactCoordinates> coordinates) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifacts
(Collection<? extends ArtifactCoordinates> coordinates, List<RemoteRepository> repositories) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveArtifacts
(Artifact... artifacts) Shortcut forgetService(ArtifactResolver.class).resolve(...)
.resolveArtifacts
(ArtifactCoordinates... coordinates) Shortcut forgetService(ArtifactResolver.class).resolve(...)
resolveDependencies
(List<DependencyCoordinates> dependencies) Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.resolveDependencies
(DependencyCoordinates dependency) Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.resolveDependencies
(DependencyCoordinates dependency, PathScope scope, Collection<PathType> desiredTypes) Shortcut forgetService(DependencyResolver.class).resolve(...).getDispatchedPaths()
.resolveDependencies
(Project project, PathScope scope) Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.resolveDependencies
(Project project, PathScope scope, Collection<PathType> desiredTypes) Shortcut forgetService(DependencyResolver.class).resolve(...).getDispatchedPaths()
.resolveVersion
(ArtifactCoordinates artifact) Resolves an artifact's meta version (if any) to a concrete version.resolveVersionRange
(ArtifactCoordinates artifact) Expands a version range to a list of matching versions, in ascending order.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 forgetService(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<? extends 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.withLocalRepository
(LocalRepository localRepository) Creates a derived session using the given local repository.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
getRootDirectory, getStartTime, getSystemProperties, getTopDirectory, getUserProperties, toBuilder
Methods inherited from interface org.apache.maven.api.Session
getDegreeOfConcurrency, getEffectiveProperties, getMavenVersion, getPluginContext, getProjects, getSettings
-
Field Details
-
session
protected final org.eclipse.aether.RepositorySystemSession session -
repositorySystem
protected final org.eclipse.aether.RepositorySystem repositorySystem -
repositories
-
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 interfaceInternalSession
-
getNode
- Specified by:
getNode
in interfaceInternalSession
-
getNode
- Specified by:
getNode
in interfaceInternalSession
-
getArtifact
- Specified by:
getArtifact
in interfaceInternalSession
-
getArtifact
public <T extends Artifact> T getArtifact(Class<T> clazz, org.eclipse.aether.artifact.Artifact artifact) - Specified by:
getArtifact
in interfaceInternalSession
-
getDependency
- Specified by:
getDependency
in interfaceInternalSession
-
toRepositories
public List<org.eclipse.aether.repository.RemoteRepository> toRepositories(List<RemoteRepository> repositories) - Specified by:
toRepositories
in interfaceInternalSession
-
toRepository
- Specified by:
toRepository
in interfaceInternalSession
-
toRepository
- Specified by:
toRepository
in interfaceInternalSession
-
toDependencies
public List<org.eclipse.aether.graph.Dependency> toDependencies(Collection<DependencyCoordinates> dependencies, boolean managed) - Specified by:
toDependencies
in interfaceInternalSession
-
getRemoteRepositories
Description copied from interface:Session
Retrieves a list of remote repositories associated with this session.- Specified by:
getRemoteRepositories
in interfaceSession
- Returns:
- a list of remote repositories
-
getData
Description copied from interface:Session
Retrieves the session data associated with this session. -
getLocalRepository
Description copied from interface:Session
Retrieves the local repository associated with this session.- Specified by:
getLocalRepository
in interfaceSession
- Returns:
- the local repository instance
-
withLocalRepository
Description copied from interface:Session
Creates a derived session using the given local repository.- Specified by:
withLocalRepository
in interfaceSession
- Parameters:
localRepository
- the new local repository- Returns:
- the derived session
-
withRemoteRepositories
Description copied from interface:Session
Creates a derived session using the given remote repositories.- Specified by:
withRemoteRepositories
in interfaceSession
- 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
Description copied from interface:Session
Retrieves the service for the interface- Specified by:
getService
in interfaceSession
- Throws:
NoSuchElementException
- if the service could not be found
-
getSession
- Specified by:
getSession
in interfaceInternalSession
-
getRepositorySystem
- Specified by:
getRepositorySystem
in interfaceInternalSession
-
toDependency
public org.eclipse.aether.graph.Dependency toDependency(DependencyCoordinates dependency, boolean managed) - Specified by:
toDependency
in interfaceInternalSession
-
toArtifacts
public List<org.eclipse.aether.artifact.Artifact> toArtifacts(Collection<? extends Artifact> artifacts) - Specified by:
toArtifacts
in interfaceInternalSession
-
toArtifact
- Specified by:
toArtifact
in interfaceInternalSession
-
toArtifact
- Specified by:
toArtifact
in interfaceInternalSession
-
registerListener
Description copied from interface:Session
Register the given listener which will receive all events.- Specified by:
registerListener
in interfaceSession
- Parameters:
listener
- the listener to register
-
unregisterListener
Description copied from interface:Session
Unregisters a previously registered listener.- Specified by:
unregisterListener
in interfaceSession
- Parameters:
listener
- the listener to unregister
-
getListeners
Description copied from interface:Session
Returns the list of registered listeners.- Specified by:
getListeners
in interfaceSession
- Returns:
- an immutable collection of listeners, never
null
-
createLocalRepository
Shortcut forgetService(RepositoryFactory.class).createLocal(...)
- Specified by:
createLocalRepository
in interfaceSession
- Parameters:
path
- location of the local repository to create- Returns:
- cache of artifacts downloaded from a remote repository or built locally
- See Also:
-
createRemoteRepository
Shortcut forgetService(RepositoryFactory.class).createRemote(...)
- Specified by:
createRemoteRepository
in interfaceSession
- Parameters:
id
- identifier of the remote repository to createurl
- location of the remote repository- Returns:
- remote repository that can be used to download or upload artifacts
- See Also:
-
createRemoteRepository
Shortcut forgetService(RepositoryFactory.class).createRemote(...)
- Specified by:
createRemoteRepository
in interfaceSession
- Parameters:
repository
- information needed for establishing connections with remote repository- Returns:
- remote repository that can be used to download or upload artifacts
- See Also:
-
createArtifactCoordinates
public ArtifactCoordinates createArtifactCoordinates(String groupId, String artifactId, String version, String extension) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
- Specified by:
createArtifactCoordinates
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecified- Returns:
- coordinates used to point to the artifact
- See Also:
-
createArtifactCoordinates
Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
- Specified by:
createArtifactCoordinates
in interfaceSession
- Parameters:
coordString
- the string having "standard" coordinates.- Returns:
- coordinates used to point to the artifact
- See Also:
-
createArtifactCoordinates
public ArtifactCoordinates createArtifactCoordinates(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
- Specified by:
createArtifactCoordinates
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedclassifier
- the artifact classifier, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecifiedtype
- the artifact type, ornull
is unspecified- Returns:
- coordinates used to point to the artifact
- See Also:
-
createArtifactCoordinates
Shortcut forgetService(ArtifactCoordinatesFactory.class).create(...)
- Specified by:
createArtifactCoordinates
in interfaceSession
- Parameters:
artifact
- artifact from which to get coordinates- Returns:
- coordinates used to point to the artifact
- See Also:
-
createArtifact
Shortcut forgetService(ArtifactFactory.class).create(...)
- Specified by:
createArtifact
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecified- Returns:
- artifact with the given coordinates
- See Also:
-
createArtifact
public Artifact createArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactFactory.class).create(...)
- Specified by:
createArtifact
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedclassifier
- the artifact classifier, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecifiedtype
- the artifact type, ornull
is unspecified- Returns:
- artifact with the given coordinates
- See Also:
-
createProducedArtifact
public ProducedArtifact createProducedArtifact(String groupId, String artifactId, String version, String extension) Shortcut forgetService(ArtifactFactory.class).createProduced(...)
- Specified by:
createProducedArtifact
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecified- Returns:
- artifact with the given coordinates
- See Also:
-
createProducedArtifact
public ProducedArtifact createProducedArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type) Shortcut forgetService(ArtifactFactory.class).createProduced(...)
- Specified by:
createProducedArtifact
in interfaceSession
- Parameters:
groupId
- the group identifier, ornull
is unspecifiedartifactId
- the artifact identifier, ornull
is unspecifiedversion
- the artifact version, ornull
is unspecifiedclassifier
- the artifact classifier, ornull
is unspecifiedextension
- the artifact extension, ornull
is unspecifiedtype
- the artifact type, ornull
is unspecified- Returns:
- artifact with the given coordinates
- See Also:
-
resolveArtifact
Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifact
in interfaceSession
- 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:
-
resolveArtifact
public DownloadedArtifact resolveArtifact(ArtifactCoordinates coordinates, List<RemoteRepository> repositories) Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifact
in interfaceSession
- Parameters:
coordinates
- coordinates of the artifact to resolverepositories
- repositories to use, ifnull
, the session repositories are used- Returns:
- requested artifact together with the path to its file
- Throws:
ArtifactResolverException
- if the artifact resolution failed- See Also:
-
resolveArtifacts
Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifacts
in interfaceSession
- 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:
-
resolveArtifacts
public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates) Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifacts
in interfaceSession
- 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:
-
resolveArtifacts
public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates, List<RemoteRepository> repositories) Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifacts
in interfaceSession
- Parameters:
coordinates
- coordinates of all artifacts to resolverepositories
- repositories to use, ifnull
, the session repositories are used- Returns:
- requested artifacts together with the paths to their files
- Throws:
ArtifactResolverException
- if the artifact resolution failed- See Also:
-
resolveArtifact
Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifact
in interfaceSession
- 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:
-
resolveArtifact
Shortcut forgetService(ArtifactResolver.class).resolve(...)
- Specified by:
resolveArtifact
in interfaceSession
- Parameters:
artifact
- the artifact to resolverepositories
- repositories to use, ifnull
, the session repositories are used- Returns:
- requested artifact together with the path to its file
- Throws:
ArtifactResolverException
- if the artifact resolution failed- See Also:
-
resolveArtifacts
Description copied from interface:Session
Shortcut forgetService(ArtifactResolver.class).resolve(...)
.- Specified by:
resolveArtifacts
in interfaceSession
- Parameters:
artifacts
- all artifacts to resolve- Returns:
- requested artifacts together with the paths to their files
- See Also:
-
installArtifacts
Shortcut forgetService(ArtifactInstaller.class).install(...)
- Specified by:
installArtifacts
in interfaceSession
- Parameters:
artifacts
- the artifacts to install- Throws:
ArtifactInstallerException
- if the artifacts installation failed- See Also:
-
installArtifacts
Shortcut forgetService(ArtifactInstaller.class).install(...)
- Specified by:
installArtifacts
in interfaceSession
- Parameters:
artifacts
- the artifacts to install- Throws:
ArtifactInstallerException
- if the artifacts installation failed- See Also:
-
deployArtifact
Shortcut forgetService(ArtifactDeployer.class).deploy(...)
- Specified by:
deployArtifact
in interfaceSession
- Parameters:
repository
- the repository where to deploy artifactsartifacts
- the artifacts to deploy- Throws:
ArtifactDeployerException
- if the artifacts deployment failed- See Also:
-
setArtifactPath
Shortcut forgetService(ArtifactManager.class).setPath(...)
- Specified by:
setArtifactPath
in interfaceSession
- Parameters:
artifact
- the artifact for which to associate a pathpath
- path to associate to the given artifact- See Also:
-
getArtifactPath
Shortcut forgetService(ArtifactManager.class).getPath(...)
- Specified by:
getArtifactPath
in interfaceSession
- Parameters:
artifact
- the artifact for which to get a path- Returns:
- path associated to the given artifact
- See Also:
-
isVersionSnapshot
Shortcut forgetService(VersionParser.class).isSnapshot(...)
- Specified by:
isVersionSnapshot
in interfaceSession
- Parameters:
version
- artifact version- Returns:
- whether the given version is a snapshot
- See Also:
-
createDependencyCoordinates
@Nonnull public DependencyCoordinates createDependencyCoordinates(@Nonnull ArtifactCoordinates coordinates) Shortcut forgetService(DependencyFactory.class).create(...)
- Specified by:
createDependencyCoordinates
in interfaceSession
- Parameters:
coordinates
- artifact coordinates to get as a dependency coordinates- Returns:
- dependency coordinates for the given artifact
- See Also:
-
createDependencyCoordinates
Shortcut forgetService(DependencyFactory.class).create(...)
- Specified by:
createDependencyCoordinates
in interfaceSession
- Parameters:
dependency
- dependency for which to get the coordinates- Returns:
- coordinates for the given dependency
- See Also:
-
collectDependencies
Shortcut forgetService(DependencyResolver.class).collect(...)
- Specified by:
collectDependencies
in interfaceSession
- Parameters:
artifact
- artifact for which to get the dependencies, including transitive onesscope
- the {link PathScope} to collect dependencies, must not benull
- Returns:
- root node of the dependency graph for the given artifact
- Throws:
DependencyResolverException
- if the dependency collection failed- See Also:
-
collectDependencies
Shortcut forgetService(DependencyResolver.class).collect(...)
- Specified by:
collectDependencies
in interfaceSession
- Parameters:
project
- project for which to get the dependencies, including transitive onesscope
- the {link PathScope} to collect dependencies, must not benull
- Returns:
- root node of the dependency graph for the given project
- Throws:
DependencyResolverException
- if the dependency collection failed- See Also:
-
collectDependencies
@Nonnull public Node collectDependencies(@Nonnull DependencyCoordinates dependency, @Nonnull PathScope scope) Shortcut forgetService(DependencyResolver.class).collect(...)
- Specified by:
collectDependencies
in interfaceSession
- Parameters:
dependency
- dependency for which to get transitive dependenciesscope
- the {link PathScope} to collect dependencies, must not benull
- Returns:
- root node of the dependency graph for the given artifact
- Throws:
DependencyResolverException
- if the dependency collection failed- See Also:
-
flattenDependencies
Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).flatten(...)
.- Specified by:
flattenDependencies
in interfaceSession
- Parameters:
node
- node for which to get a flattened listscope
- build path scope (main compile, test compile, etc.) of desired nodes- Returns:
- flattened list of node with the given build path scope
- See Also:
-
resolveDependencies
Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.- Specified by:
resolveDependencies
in interfaceSession
- Parameters:
dependency
- coordinates of the dependency for which to get the paths- Returns:
- paths to the transitive dependencies of the given dependency
- See Also:
-
resolveDependencies
Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.- Specified by:
resolveDependencies
in interfaceSession
- Parameters:
dependencies
- coordinates of all dependency for which to get the paths- Returns:
- paths to the transitive dependencies of the given dependencies
- See Also:
-
resolveDependencies
Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).resolve(...).getPaths()
.- Specified by:
resolveDependencies
in interfaceSession
- Parameters:
project
- the project for which to get dependenciesscope
- build path scope (main compile, test compile, etc.) of desired paths- Returns:
- paths to the transitive dependencies of the given project
- See Also:
-
resolveDependencies
public Map<PathType,List<Path>> resolveDependencies(@Nonnull DependencyCoordinates dependency, @Nonnull PathScope scope, @Nonnull Collection<PathType> desiredTypes) Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).resolve(...).getDispatchedPaths()
.- Specified by:
resolveDependencies
in interfaceSession
- Parameters:
dependency
- coordinates of the dependency for which to get the pathsscope
- build path scope (main compile, test compile, etc.) of desired pathsdesiredTypes
- the type of paths to include in the result- Returns:
- paths to the transitive dependencies of the given project
- See Also:
-
resolveDependencies
public Map<PathType,List<Path>> resolveDependencies(@Nonnull Project project, @Nonnull PathScope scope, @Nonnull Collection<PathType> desiredTypes) Description copied from interface:Session
Shortcut forgetService(DependencyResolver.class).resolve(...).getDispatchedPaths()
.- Specified by:
resolveDependencies
in interfaceSession
- Parameters:
project
- the project for which to get dependenciesscope
- build path scope (main compile, test compile, etc.) of desired pathsdesiredTypes
- the type of paths to include in the result- Returns:
- paths to the transitive dependencies of the given project
- See Also:
-
getPathForLocalArtifact
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 interfaceSession
- 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:
-
getPathForRemoteArtifact
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 interfaceSession
- Parameters:
remote
- the repository from where artifacts are downloadedartifact
- the artifact for which to get a path- Returns:
- path associated to the given artifact
- See Also:
-
parseVersion
Description copied from interface:Session
Parses the specified version string, for example "1.0".Shortcut for
getService(VersionParser.class).parseVersion(...)
.- Specified by:
parseVersion
in interfaceSession
- Parameters:
version
- the version string to parse- Returns:
- the version parsed from the given string
- See Also:
-
parseVersionRange
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 interfaceSession
- Parameters:
versionRange
- the version string to parse- Returns:
- the version range parsed from the given string
- See Also:
-
parseVersionConstraint
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 interfaceSession
- Parameters:
versionConstraint
- the version string to parse- Returns:
- the version constraint parsed from the given string
- See Also:
-
resolveVersion
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 interfaceSession
- Parameters:
artifact
- the artifact for which to resolve the version- Returns:
- resolved version of the given artifact
- Throws:
VersionResolverException
- if the resolution failed- See Also:
-
resolveVersionRange
public List<Version> resolveVersionRange(ArtifactCoordinates artifact) throws VersionResolverException 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 interfaceSession
- Parameters:
artifact
- the artifact for which to resolve the versions- Returns:
- a list of resolved
Version
s. - Throws:
VersionResolverException
- See Also:
-
resolveVersionRange
public List<Version> resolveVersionRange(ArtifactCoordinates artifact, List<RemoteRepository> repositories) throws VersionResolverException 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 interfaceSession
- Parameters:
artifact
- the artifact for which to resolve the versionsrepositories
- the repositories to use, or the session repositories ifnull
- Returns:
- a list of resolved
Version
s. - Throws:
VersionResolverException
- See Also:
-
requireType
Description copied from interface:Session
- Specified by:
requireType
in interfaceSession
- See Also:
-
requireLanguage
Description copied from interface:Session
Obtain theLanguage
from the specifiedid
.Shortcut for
getService(LanguageRegistry.class).require(...)
.- Specified by:
requireLanguage
in interfaceSession
- See Also:
-
requirePackaging
Description copied from interface:Session
Obtain thePackaging
from the specifiedid
.Shortcut for
getService(PackagingRegistry.class).require(...)
.- Specified by:
requirePackaging
in interfaceSession
- See Also:
-
requireProjectScope
Description copied from interface:Session
Obtain theProjectScope
from the specifiedid
.Shortcut for
getService(ProjectScopeRegistry.class).require(...)
.- Specified by:
requireProjectScope
in interfaceSession
- See Also:
-
requireDependencyScope
Description copied from interface:Session
- Specified by:
requireDependencyScope
in interfaceSession
- See Also:
-
requirePathScope
Description copied from interface:Session
Obtain thePathScope
from the specifiedid
.Shortcut for
getService(PathScopeRegistry.class).require(...)
.- Specified by:
requirePathScope
in interfaceSession
- See Also:
-