Package org.apache.maven.internal.impl

Class DefaultSession

java.lang.Object

org.apache.maven.impl.AbstractSession

org.apache.maven.internal.impl.DefaultSession

All Implemented Interfaces:

ProtoSession, Session, InternalSession, InternalMavenSession

public class DefaultSession
extends AbstractSession
implements InternalMavenSession

Nested Class Summary

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

ProtoSession.Builder

Field Summary

Fields inherited from class org.apache.maven.impl.AbstractSession

lookup, repositories, repositorySystem, session

Constructor Summary

Constructors

Constructor	Description
DefaultSession(MavenSession session, org.eclipse.aether.RepositorySystem repositorySystem, List<RemoteRepository> remoteRepositories, MavenRepositorySystem mavenRepositorySystem, Lookup lookup, RuntimeInformation runtimeInformation)

Method Summary

Modifier and Type	Method	Description
int	getDegreeOfConcurrency()	Returns the degree of concurrency for the build.
Map<String,String>	getEffectiveProperties(Project project)	Each invocation computes a new map of effective properties.
MavenSession	getMavenSession()
Version	getMavenVersion()	Returns the current maven version.
Map<String,Object>	getPluginContext(Project project)	Returns the plugin context for mojo being executed and the specified Project, never returns null as if context not present, creates it.
Project	getProject(MavenProject project)	May return null if the input project is null or is not part of the reactor.
List<Project>	getProjects()	Retrieves a list of projects associated with the session.
List<Project>	getProjects(List<MavenProject> projects)
Path	getRootDirectory()	Gets the root directory of the session, which is the root directory for the top directory project.
Settings	getSettings()	Retrieves the settings for the current session.
Instant	getStartTime()	Returns the start time of the session.
Map<String,String>	getSystemProperties()	Returns immutable system properties to use for interpolation.
Collection<ToolchainModel>	getToolchains()	Retrieves toolchain models that have been explicitly configured.
Path	getTopDirectory()	Gets the directory of the topmost project being built, usually the current directory or the directory pointed at by the -f/--file command line argument.
Map<String,String>	getUserProperties()	Returns immutable user properties to use for interpolation.
protected Session	newSession(MavenSession mavenSession, List<RemoteRepository> repositories)
protected Session	newSession(org.eclipse.aether.RepositorySystemSession repoSession, List<RemoteRepository> repositories)
List<ArtifactRepository>	toArtifactRepositories(List<RemoteRepository> repositories)
ArtifactRepository	toArtifactRepository(RemoteRepository repository)

Methods inherited from class org.apache.maven.impl.AbstractSession

collectDependencies, collectDependencies, collectDependencies, createArtifact, createArtifact, createArtifactCoordinates, createArtifactCoordinates, createArtifactCoordinates, createArtifactCoordinates, createDependencyCoordinates, createDependencyCoordinates, createLocalRepository, createProducedArtifact, createProducedArtifact, createRemoteRepository, createRemoteRepository, deployArtifact, flattenDependencies, getArtifact, getArtifact, getArtifactPath, getCurrentTrace, getData, getDependency, getListeners, getLocalRepository, getLocalRepository, getNode, getNode, getPathForLocalArtifact, getPathForRemoteArtifact, getRemoteRepositories, getRemoteRepository, getRepository, getRepositorySystem, getService, getSession, getWorkspaceRepository, installArtifacts, installArtifacts, isVersionSnapshot, parseVersion, parseVersionConstraint, parseVersionRange, registerListener, request, requests, requireDependencyScope, requireLanguage, requirePackaging, requirePathScope, requireProjectScope, requireType, resolveArtifact, resolveArtifact, resolveArtifact, resolveArtifact, resolveArtifacts, resolveArtifacts, resolveArtifacts, resolveArtifacts, resolveDependencies, resolveDependencies, resolveDependencies, resolveDependencies, resolveDependencies, resolveHighestVersion, resolveVersion, resolveVersionRange, resolveVersionRange, setArtifactPath, setCurrentTrace, toArtifact, toArtifact, toArtifacts, toDependencies, toDependency, toRepositories, toRepository, toRepository, unregisterListener, withLocalRepository, withRemoteRepositories

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

getArtifact, getArtifact, getCurrentTrace, getDependency, getLocalRepository, getNode, getNode, getRemoteRepository, getRepository, getRepositorySystem, getSession, getWorkspaceRepository, request, requests, setCurrentTrace, toArtifact, toArtifact, toArtifacts, toDependencies, toDependency, toRepositories, toRepository, toRepository

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

toBuilder

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

collectDependencies, collectDependencies, collectDependencies, createArtifact, createArtifact, createArtifactCoordinates, createArtifactCoordinates, createArtifactCoordinates, createArtifactCoordinates, createDependencyCoordinates, createDependencyCoordinates, createLocalRepository, createProducedArtifact, createProducedArtifact, createRemoteRepository, createRemoteRepository, deployArtifact, flattenDependencies, getArtifactPath, getData, getListeners, getLocalRepository, getPathForLocalArtifact, getPathForRemoteArtifact, getRemoteRepositories, getService, installArtifacts, installArtifacts, isVersionSnapshot, parseVersion, parseVersionConstraint, parseVersionRange, registerListener, requireDependencyScope, requireLanguage, requirePackaging, requirePathScope, requireProjectScope, requireType, resolveArtifact, resolveArtifact, resolveArtifact, resolveArtifact, resolveArtifacts, resolveArtifacts, resolveArtifacts, resolveArtifacts, resolveDependencies, resolveDependencies, resolveDependencies, resolveDependencies, resolveDependencies, resolveHighestVersion, resolveVersion, resolveVersionRange, resolveVersionRange, setArtifactPath, unregisterListener, withLocalRepository, withRemoteRepositories

Constructor Details

DefaultSession

public DefaultSession(@Nonnull
 MavenSession session,
 @Nonnull
 org.eclipse.aether.RepositorySystem repositorySystem,
 @Nullable
 List<RemoteRepository> remoteRepositories,
 @Nonnull
 MavenRepositorySystem mavenRepositorySystem,
 @Nonnull
 Lookup lookup,
 @Nonnull
 RuntimeInformation runtimeInformation)

Method Details

getMavenSession

public MavenSession getMavenSession()

Specified by:

getMavenSession in interface InternalMavenSession

getProjects

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

Specified by:

getProjects in interface InternalMavenSession

getProject

public Project getProject(MavenProject project)

Description copied from interface: InternalMavenSession

May return null if the input project is null or is not part of the reactor.

Specified by:

getProject in interface InternalMavenSession

toArtifactRepositories

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

Specified by:

toArtifactRepositories in interface InternalMavenSession

getSettings

@Nonnull
public Settings getSettings()

Description copied from interface: Session

Retrieves the settings for the current session.

Specified by:

getSettings in interface Session

Returns:

the settings instance

getToolchains

@Nonnull
public Collection<ToolchainModel> getToolchains()

Description copied from interface: Session

Retrieves toolchain models that have been explicitly configured.

Specified by:

getToolchains in interface Session

Returns:

the toolchain models

getUserProperties

@Nonnull
public Map<String,String> getUserProperties()

Description copied from interface: ProtoSession

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

Specified by:

getUserProperties in interface ProtoSession

Returns:

the user properties, never null

getSystemProperties

@Nonnull
public Map<String,String> getSystemProperties()

Description copied from interface: ProtoSession

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

Specified by:

getSystemProperties in interface ProtoSession

Returns:

the system properties, never null

getEffectiveProperties

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

Description copied from interface: Session

Each invocation computes a new map of effective properties. To be used in interpolation.

Effective properties are computed from system, user and optionally project properties, layered with defined precedence onto each other to achieve proper precedence. Precedence is defined as:

• System properties (lowest precedence)
• Project properties (optional)
• User properties (highest precedence)

Note: Project properties contains properties injected from profiles, if applicable. Their precedence is profile > project, hence active profile property may override project property.

The caller of this method should decide whether there is a project in scope (hence, a project instance needs to be passed) or not.

Specified by:

getEffectiveProperties in interface Session

Parameters:

project - Project or null.

Returns:

the effective properties, never null

getMavenVersion

@Nonnull
public Version getMavenVersion()

Description copied from interface: Session

Returns the current maven version.

Specified by:

getMavenVersion in interface Session

Returns:

the maven version, never null

getDegreeOfConcurrency

public int getDegreeOfConcurrency()

Description copied from interface: Session

Returns the degree of concurrency for the build.

Specified by:

getDegreeOfConcurrency in interface Session

Returns:

the degree of concurrency

getStartTime

@Nonnull
public Instant getStartTime()

Description copied from interface: ProtoSession

Returns the start time of the session.

Specified by:

getStartTime in interface ProtoSession

Returns:

the start time as an Instant object, never null

getRootDirectory

public Path getRootDirectory()

Description copied from interface: ProtoSession

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

Specified by:

getRootDirectory in interface ProtoSession

Returns:

the root directory, never null

See Also:

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

getTopDirectory

public Path getTopDirectory()

Description copied from interface: ProtoSession

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

Specified by:

getTopDirectory in interface ProtoSession

Returns:

the directory of the topmost project, never null

See Also:

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

getProjects

@Nonnull
public List<Project> getProjects()

Description copied from interface: Session

Retrieves a list of projects associated with the session.

Specified by:

getProjects in interface Session

Returns:

a list of projects, never null

getPluginContext

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

Description copied from interface: Session

Returns the plugin context for mojo being executed and the specified Project, never returns null as if context not present, creates it. Implementation note: while this method return type is Map, the returned map instance implements ConcurrentMap as well.

Specified by:

getPluginContext in interface Session

newSession

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

Specified by:

newSession in class AbstractSession

newSession

protected Session newSession(MavenSession mavenSession,
 List<RemoteRepository> repositories)

toArtifactRepository

public ArtifactRepository toArtifactRepository(RemoteRepository repository)

Specified by:

toArtifactRepository in interface InternalMavenSession