Package org.apache.maven.execution

Class MavenSession

java.lang.Object

org.apache.maven.execution.MavenSession

All Implemented Interfaces:

Cloneable

public class MavenSession
extends Object
implements Cloneable

A Maven execution session.

Field Summary

Fields

Modifier and Type	Field	Description
private List<MavenProject>	allProjects	The full set of projects before any potential constraining by --projects.
private final org.codehaus.plexus.PlexusContainer	container
private ThreadLocal<MavenProject>	currentProject
private final Properties	executionProperties
private boolean	parallel
private final ConcurrentMap<String,ConcurrentMap<String,ConcurrentMap<String,Object>>>	pluginContextsByProjectAndPluginKey	Plugin context keyed by project (MavenProject.getId()) and by plugin lookup key (PluginDescriptor.getPluginLookupKey()).
private ProjectDependencyGraph	projectDependencyGraph
private Map<String,MavenProject>	projectMap
private List<MavenProject>	projects	These projects have already been topologically sorted in the Maven component before being passed into the session.
private final org.eclipse.aether.RepositorySystemSession	repositorySystemSession
private final MavenExecutionRequest	request
private final MavenExecutionResult	result
private Session	session
private final Settings	settings
private MavenProject	topLevelProject

Constructor Summary

Constructors

Constructor	Description
MavenSession(org.codehaus.plexus.PlexusContainer container, MavenExecutionRequest request, MavenExecutionResult result, List<MavenProject> projects)	Deprecated.
MavenSession(org.codehaus.plexus.PlexusContainer container, MavenExecutionRequest request, MavenExecutionResult result, MavenProject project)	Deprecated.
MavenSession(org.codehaus.plexus.PlexusContainer container, Settings settings, ArtifactRepository localRepository, EventDispatcher eventDispatcher, ReactorManager unused, List<String> goals, String executionRootDir, Properties executionProperties, Date startTime)	Deprecated.
MavenSession(org.codehaus.plexus.PlexusContainer container, Settings settings, ArtifactRepository localRepository, EventDispatcher eventDispatcher, ReactorManager unused, List<String> goals, String executionRootDir, Properties executionProperties, Properties userProperties, Date startTime)	Deprecated.
MavenSession(org.codehaus.plexus.PlexusContainer container, org.eclipse.aether.RepositorySystemSession repositorySession, MavenExecutionRequest request, MavenExecutionResult result)	Deprecated.
MavenSession(org.eclipse.aether.RepositorySystemSession repositorySystemSession, MavenExecutionRequest request, MavenExecutionResult result)

Method Summary

Modifier and Type	Method	Description
private static Settings	adaptSettings(MavenExecutionRequest request)	Adapt a MavenExecutionRequest to a Settings object for use in the Maven core.
MavenSession	clone()
List<MavenProject>	getAllProjects()	This is a provisional method and may be removed
org.codehaus.plexus.PlexusContainer	getContainer()	Deprecated.
MavenProject	getCurrentProject()
EventDispatcher	getEventDispatcher()	Deprecated.
Properties	getExecutionProperties()	Deprecated. Use either getUserProperties() or getSystemProperties().
String	getExecutionRootDirectory()	Deprecated. use getTopDirectory() ()}
List<String>	getGoals()
ArtifactRepository	getLocalRepository()
Map<String,Object>	getPluginContext(PluginDescriptor plugin, MavenProject project)	Returns the plugin context for given key (PluginDescriptor.getPluginLookupKey() and MavenProject, never returns null as if context not present, creates it.
List<String>	getPluginGroups()
ProjectBuildingRequest	getProjectBuildingRequest()
ProjectDependencyGraph	getProjectDependencyGraph()
Map<String,MavenProject>	getProjectMap()	Deprecated.
List<MavenProject>	getProjects()
String	getReactorFailureBehavior()
RepositoryCache	getRepositoryCache()	Deprecated.
org.eclipse.aether.RepositorySystemSession	getRepositorySession()
MavenExecutionRequest	getRequest()
MavenExecutionResult	getResult()
Path	getRootDirectory()
Session	getSession()
Settings	getSettings()
List<MavenProject>	getSortedProjects()	Deprecated.
Instant	getStartInstant()
Date	getStartTime()	Deprecated.
Properties	getSystemProperties()	Gets the system properties to use for interpolation and profile activation.
Path	getTopDirectory()
MavenProject	getTopLevelProject()
Properties	getUserProperties()	Gets the user properties to use for interpolation and profile activation.
boolean	isOffline()
boolean	isParallel()
boolean	isUsingPOMsFromFilesystem()	Deprecated.
Object	lookup(String role)	Deprecated.
Object	lookup(String role, String roleHint)	Deprecated.
List<Object>	lookupList(String role)	Deprecated.
Map<String,Object>	lookupMap(String role)	Deprecated.
void	setAllProjects(List<MavenProject> allProjects)	This is a provisional method and may be removed
void	setCurrentProject(MavenProject currentProject)
void	setParallel(boolean parallel)
void	setProjectDependencyGraph(ProjectDependencyGraph projectDependencyGraph)
void	setProjectMap(Map<String,MavenProject> projectMap)
void	setProjects(List<MavenProject> projects)
void	setSession(Session session)

Methods inherited from class java.lang.Object

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

Field Details

request

private final MavenExecutionRequest request

result

private final MavenExecutionResult result

repositorySystemSession

private final org.eclipse.aether.RepositorySystemSession repositorySystemSession

executionProperties

private final Properties executionProperties

currentProject

private ThreadLocal<MavenProject> currentProject

projects

private List<MavenProject> projects

These projects have already been topologically sorted in the Maven component before being passed into the session. This is also the potentially constrained set of projects by using --projects on the command line.

allProjects

private List<MavenProject> allProjects

The full set of projects before any potential constraining by --projects. Useful in the case where you want to build a smaller set of projects but perform other operations in the context of your reactor.

topLevelProject

private MavenProject topLevelProject

projectDependencyGraph

private ProjectDependencyGraph projectDependencyGraph

parallel

private boolean parallel

pluginContextsByProjectAndPluginKey

private final ConcurrentMap<String,ConcurrentMap<String,ConcurrentMap<String,Object>>> pluginContextsByProjectAndPluginKey

Plugin context keyed by project (MavenProject.getId()) and by plugin lookup key (PluginDescriptor.getPluginLookupKey()). Plugin contexts itself are mappings of String keys to Object values.

projectMap

private Map<String,MavenProject> projectMap

container

private final org.codehaus.plexus.PlexusContainer container

settings

private final Settings settings

session

private Session session

Constructor Details

MavenSession

public MavenSession(org.eclipse.aether.RepositorySystemSession repositorySystemSession,
 MavenExecutionRequest request,
 MavenExecutionResult result)

MavenSession

@Deprecated
public MavenSession(org.codehaus.plexus.PlexusContainer container,
 org.eclipse.aether.RepositorySystemSession repositorySession,
 MavenExecutionRequest request,
 MavenExecutionResult result)

Deprecated.

MavenSession

@Deprecated
public MavenSession(org.codehaus.plexus.PlexusContainer container,
 MavenExecutionRequest request,
 MavenExecutionResult result,
 MavenProject project)

Deprecated.

MavenSession

@Deprecated
public MavenSession(org.codehaus.plexus.PlexusContainer container,
 Settings settings,
 ArtifactRepository localRepository,
 EventDispatcher eventDispatcher,
 ReactorManager unused,
 List<String> goals,
 String executionRootDir,
 Properties executionProperties,
 Date startTime)

Deprecated.

MavenSession

@Deprecated
public MavenSession(org.codehaus.plexus.PlexusContainer container,
 Settings settings,
 ArtifactRepository localRepository,
 EventDispatcher eventDispatcher,
 ReactorManager unused,
 List<String> goals,
 String executionRootDir,
 Properties executionProperties,
 Properties userProperties,
 Date startTime)

Deprecated.

MavenSession

@Deprecated
public MavenSession(org.codehaus.plexus.PlexusContainer container,
 MavenExecutionRequest request,
 MavenExecutionResult result,
 List<MavenProject> projects)

Deprecated.

Method Details

setProjects

public void setProjects(List<MavenProject> projects)

getLocalRepository

public ArtifactRepository getLocalRepository()

getGoals

public List<String> getGoals()

getUserProperties

public Properties getUserProperties()

Gets the user properties to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the -Dkey=value parameter on the command line.

Returns:

The user properties, never null.

getSystemProperties

public Properties getSystemProperties()

Gets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.

Returns:

The system properties, never null.

getSettings

public Settings getSettings()

getProjects

public List<MavenProject> getProjects()

getExecutionRootDirectory

@Deprecated
public String getExecutionRootDirectory()

Deprecated.

use getTopDirectory() ()}

getTopDirectory

public Path getTopDirectory()

Since:

4.0.0

See Also:

• MavenExecutionRequest.getTopDirectory()

getRootDirectory

public Path getRootDirectory()

Since:

4.0.0

See Also:

• MavenExecutionRequest.getRootDirectory()

getRequest

public MavenExecutionRequest getRequest()

setCurrentProject

public void setCurrentProject(MavenProject currentProject)

getCurrentProject

public MavenProject getCurrentProject()

getProjectBuildingRequest

public ProjectBuildingRequest getProjectBuildingRequest()

getPluginGroups

public List<String> getPluginGroups()

isOffline

public boolean isOffline()

getTopLevelProject

public MavenProject getTopLevelProject()

getResult

public MavenExecutionResult getResult()

getPluginContext

public Map<String,Object> getPluginContext(PluginDescriptor plugin,
 MavenProject project)

Returns the plugin context for given key (PluginDescriptor.getPluginLookupKey() and MavenProject, 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.

getProjectDependencyGraph

public ProjectDependencyGraph getProjectDependencyGraph()

setProjectDependencyGraph

public void setProjectDependencyGraph(ProjectDependencyGraph projectDependencyGraph)

getReactorFailureBehavior

public String getReactorFailureBehavior()

clone

public MavenSession clone()

Overrides:

clone in class Object

getStartTime

@Deprecated
public Date getStartTime()

Deprecated.

getStartInstant

public Instant getStartInstant()

isParallel

public boolean isParallel()

setParallel

public void setParallel(boolean parallel)

getRepositorySession

public org.eclipse.aether.RepositorySystemSession getRepositorySession()

setProjectMap

public void setProjectMap(Map<String,MavenProject> projectMap)

getAllProjects

public List<MavenProject> getAllProjects()

This is a provisional method and may be removed

setAllProjects

public void setAllProjects(List<MavenProject> allProjects)

This is a provisional method and may be removed

getProjectMap

@Deprecated
public Map<String,MavenProject> getProjectMap()

Deprecated.

adaptSettings

private static Settings adaptSettings(MavenExecutionRequest request)

Adapt a MavenExecutionRequest to a Settings object for use in the Maven core. We want to make sure that what is ask for in the execution request overrides what is in the settings. The CLI feeds into an execution request so if a particular value is present in the execution request then we will take that over the value coming from the user settings.

getSortedProjects

@Deprecated
public List<MavenProject> getSortedProjects()

Deprecated.

getRepositoryCache

@Deprecated
public RepositoryCache getRepositoryCache()

Deprecated.

getEventDispatcher

@Deprecated
public EventDispatcher getEventDispatcher()

Deprecated.

isUsingPOMsFromFilesystem

@Deprecated
public boolean isUsingPOMsFromFilesystem()

Deprecated.

getExecutionProperties

@Deprecated
public Properties getExecutionProperties()

Deprecated.

Use either getUserProperties() or getSystemProperties().

getContainer

@Deprecated
public org.codehaus.plexus.PlexusContainer getContainer()

Deprecated.

lookup

@Deprecated
public Object lookup(String role)
              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Deprecated.

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

lookup

@Deprecated
public Object lookup(String role,
 String roleHint)
              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Deprecated.

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

lookupList

@Deprecated
public List<Object> lookupList(String role)
                        throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Deprecated.

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

lookupMap

@Deprecated
public Map<String,Object> lookupMap(String role)
                             throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Deprecated.

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getSession

public Session getSession()

setSession

public void setSession(Session session)