Package org.apache.maven.execution

Interface MavenExecutionRequest

All Known Implementing Classes:

DefaultMavenExecutionRequest

public interface MavenExecutionRequest

Author:

Jason van Zyl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKSUM_POLICY_FAIL
static final String	CHECKSUM_POLICY_WARN
static final int	LOGGING_LEVEL_DEBUG
static final int	LOGGING_LEVEL_DISABLED
static final int	LOGGING_LEVEL_ERROR
static final int	LOGGING_LEVEL_FATAL
static final int	LOGGING_LEVEL_INFO
static final int	LOGGING_LEVEL_WARN
static final String	REACTOR_FAIL_AT_END
static final String	REACTOR_FAIL_FAST
static final String	REACTOR_FAIL_NEVER
static final String	REACTOR_MAKE_BOTH
static final String	REACTOR_MAKE_DOWNSTREAM
static final String	REACTOR_MAKE_UPSTREAM

Method Summary

Modifier and Type	Method	Description
MavenExecutionRequest	addActiveProfile(String profile)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	addActiveProfiles(List<String> profiles)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	addInactiveProfile(String profile)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	addInactiveProfiles(List<String> profiles)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	addMirror(Mirror mirror)
MavenExecutionRequest	addPluginArtifactRepository(ArtifactRepository repository)
MavenExecutionRequest	addPluginGroup(String pluginGroup)
MavenExecutionRequest	addPluginGroups(List<String> pluginGroups)
MavenExecutionRequest	addProfile(Profile profile)
MavenExecutionRequest	addProxy(Proxy proxy)
MavenExecutionRequest	addRemoteRepository(ArtifactRepository repository)
MavenExecutionRequest	addServer(Server server)
List<String>	getActiveProfiles()	Deprecated. Since Maven 4: use getProfileActivation().
String	getBaseDirectory()
String	getBuilderId()	Controls the Builder used by Maven by specification of the builders id.
Map<String,Object>	getData()
int	getDegreeOfConcurrency()
EventSpyDispatcher	getEventSpyDispatcher()
List<String>	getExcludedProjects()	Deprecated. Since Maven 4: use getProjectActivation().
ExecutionListener	getExecutionListener()
String	getGlobalChecksumPolicy()
File	getGlobalSettingsFile()
File	getGlobalToolchainsFile()
List<String>	getGoals()
List<String>	getInactiveProfiles()	Deprecated. Since Maven 4: use getProfileActivation().
ArtifactRepository	getLocalRepository()
File	getLocalRepositoryPath()
int	getLoggingLevel()
String	getMakeBehavior()
List<Mirror>	getMirrors()
File	getMultiModuleProjectDirectory()
List<ArtifactRepository>	getPluginArtifactRepositories()
List<String>	getPluginGroups()
File	getPom()
ProfileActivation	getProfileActivation()	Return the requested activation(s) of profile(s) in this execution.
List<Profile>	getProfiles()
ProjectActivation	getProjectActivation()	Return the requested activation(s) of project(s) in this execution.
ProjectBuildingRequest	getProjectBuildingRequest()
List<Proxy>	getProxies()
String	getReactorFailureBehavior()
List<ArtifactRepository>	getRemoteRepositories()
org.eclipse.aether.RepositoryCache	getRepositoryCache()
String	getResumeFrom()
List<String>	getSelectedProjects()	Deprecated. Since Maven 4: use getProjectActivation().
List<Server>	getServers()
Date	getStartTime()
Properties	getSystemProperties()	Gets the system properties to use for interpolation and profile activation.
Map<String,List<ToolchainModel>>	getToolchains()
org.eclipse.aether.transfer.TransferListener	getTransferListener()
Properties	getUserProperties()	Gets the user properties to use for interpolation and profile activation.
File	getUserSettingsFile()
File	getUserToolchainsFile()
org.eclipse.aether.repository.WorkspaceReader	getWorkspaceReader()
boolean	isCacheNotFound()
boolean	isCacheTransferError()
boolean	isInteractiveMode()
boolean	isNoSnapshotUpdates()
boolean	isOffline()
boolean	isProjectPresent()
boolean	isRecursive()
boolean	isResume()
boolean	isShowErrors()
boolean	isUpdateSnapshots()
boolean	isUseLegacyLocalRepository()	Deprecated. Since 3.9 there is no direct Maven2 interop offered at LRM level.
MavenExecutionRequest	setActiveProfiles(List<String> profiles)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	setBaseDirectory(File basedir)
MavenExecutionRequest	setBuilderId(String builderId)	Controls the Builder used by Maven by specification of the builder's id.
MavenExecutionRequest	setCacheNotFound(boolean cacheNotFound)
MavenExecutionRequest	setCacheTransferError(boolean cacheTransferError)
void	setDegreeOfConcurrency(int degreeOfConcurrency)	Set's the parallel degree of concurrency used by the build.
MavenExecutionRequest	setEventSpyDispatcher(EventSpyDispatcher eventSpyDispatcher)
MavenExecutionRequest	setExcludedProjects(List<String> projects)	Deprecated. Since Maven 4: use getProjectActivation().
MavenExecutionRequest	setExecutionListener(ExecutionListener executionListener)
MavenExecutionRequest	setGlobalChecksumPolicy(String globalChecksumPolicy)
MavenExecutionRequest	setGlobalSettingsFile(File globalSettingsFile)
MavenExecutionRequest	setGlobalToolchainsFile(File globalToolchainsFile)
MavenExecutionRequest	setGoals(List<String> goals)
MavenExecutionRequest	setInactiveProfiles(List<String> profiles)	Deprecated. Since Maven 4: use getProfileActivation().
MavenExecutionRequest	setInteractiveMode(boolean interactive)
MavenExecutionRequest	setLocalRepository(ArtifactRepository repository)
MavenExecutionRequest	setLocalRepositoryPath(File localRepository)
MavenExecutionRequest	setLocalRepositoryPath(String localRepository)
MavenExecutionRequest	setLoggingLevel(int loggingLevel)
MavenExecutionRequest	setMakeBehavior(String makeBehavior)
MavenExecutionRequest	setMirrors(List<Mirror> mirrors)
void	setMultiModuleProjectDirectory(File file)
MavenExecutionRequest	setNoSnapshotUpdates(boolean noSnapshotUpdates)
MavenExecutionRequest	setOffline(boolean offline)
MavenExecutionRequest	setPluginArtifactRepositories(List<ArtifactRepository> repositories)
MavenExecutionRequest	setPluginGroups(List<String> pluginGroups)
MavenExecutionRequest	setPom(File pom)
MavenExecutionRequest	setProfiles(List<Profile> profiles)
MavenExecutionRequest	setProjectPresent(boolean isProjectPresent)
MavenExecutionRequest	setProxies(List<Proxy> proxies)
MavenExecutionRequest	setReactorFailureBehavior(String failureBehavior)
MavenExecutionRequest	setRecursive(boolean recursive)
MavenExecutionRequest	setRemoteRepositories(List<ArtifactRepository> repositories)	Set a new list of remote repositories to use the execution request.
MavenExecutionRequest	setRepositoryCache(org.eclipse.aether.RepositoryCache repositoryCache)
MavenExecutionRequest	setResume(boolean resume)	Sets whether the build should be resumed from the data in the resume.properties file.
MavenExecutionRequest	setResumeFrom(String project)
MavenExecutionRequest	setSelectedProjects(List<String> projects)	Deprecated. Since Maven 4: use getProjectActivation().
MavenExecutionRequest	setServers(List<Server> servers)
MavenExecutionRequest	setShowErrors(boolean showErrors)
MavenExecutionRequest	setStartTime(Date start)
MavenExecutionRequest	setSystemProperties(Properties systemProperties)	Sets the system properties to use for interpolation and profile activation.
MavenExecutionRequest	setToolchains(Map<String,List<ToolchainModel>> toolchains)
MavenExecutionRequest	setTransferListener(org.eclipse.aether.transfer.TransferListener transferListener)
MavenExecutionRequest	setUpdateSnapshots(boolean updateSnapshots)
MavenExecutionRequest	setUseLegacyLocalRepository(boolean useLegacyLocalRepository)	Deprecated. Since 3.9 there is no direct Maven2 interop offered at LRM level.
MavenExecutionRequest	setUserProperties(Properties userProperties)	Sets the user properties to use for interpolation and profile activation.
MavenExecutionRequest	setUserSettingsFile(File userSettingsFile)
MavenExecutionRequest	setUserToolchainsFile(File userToolchainsFile)
MavenExecutionRequest	setWorkspaceReader(org.eclipse.aether.repository.WorkspaceReader workspaceReader)

Field Details

LOGGING_LEVEL_DEBUG

static final int LOGGING_LEVEL_DEBUG

See Also:

• Constant Field Values

LOGGING_LEVEL_INFO

static final int LOGGING_LEVEL_INFO

See Also:

• Constant Field Values

LOGGING_LEVEL_WARN

static final int LOGGING_LEVEL_WARN

See Also:

• Constant Field Values

LOGGING_LEVEL_ERROR

static final int LOGGING_LEVEL_ERROR

See Also:

• Constant Field Values

LOGGING_LEVEL_FATAL

static final int LOGGING_LEVEL_FATAL

See Also:

• Constant Field Values

LOGGING_LEVEL_DISABLED

static final int LOGGING_LEVEL_DISABLED

See Also:

• Constant Field Values

REACTOR_FAIL_FAST

static final String REACTOR_FAIL_FAST

See Also:

• Constant Field Values

REACTOR_FAIL_AT_END

static final String REACTOR_FAIL_AT_END

See Also:

• Constant Field Values

REACTOR_FAIL_NEVER

static final String REACTOR_FAIL_NEVER

See Also:

• Constant Field Values

REACTOR_MAKE_UPSTREAM

static final String REACTOR_MAKE_UPSTREAM

See Also:

• Constant Field Values

REACTOR_MAKE_DOWNSTREAM

static final String REACTOR_MAKE_DOWNSTREAM

See Also:

• Constant Field Values

REACTOR_MAKE_BOTH

static final String REACTOR_MAKE_BOTH

See Also:

• Constant Field Values

CHECKSUM_POLICY_FAIL

static final String CHECKSUM_POLICY_FAIL

See Also:

• Constant Field Values

CHECKSUM_POLICY_WARN

static final String CHECKSUM_POLICY_WARN

See Also:

• Constant Field Values

Method Details

setBaseDirectory

MavenExecutionRequest setBaseDirectory(File basedir)

getBaseDirectory

String getBaseDirectory()

setStartTime

MavenExecutionRequest setStartTime(Date start)

getStartTime

Date getStartTime()

setGoals

MavenExecutionRequest setGoals(List<String> goals)

getGoals

List<String> getGoals()

setSystemProperties

MavenExecutionRequest setSystemProperties(Properties systemProperties)

Sets 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.

Parameters:

systemProperties - The system properties, may be null.

Returns:

This request, never null.

getSystemProperties

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.

setUserProperties

MavenExecutionRequest setUserProperties(Properties userProperties)

Sets 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.

Parameters:

userProperties - The user properties, may be null.

Returns:

This request, never null.

getUserProperties

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.

setReactorFailureBehavior

MavenExecutionRequest setReactorFailureBehavior(String failureBehavior)

getReactorFailureBehavior

String getReactorFailureBehavior()

setSelectedProjects

@Deprecated
MavenExecutionRequest setSelectedProjects(List<String> projects)

Deprecated.

Since Maven 4: use getProjectActivation().

getSelectedProjects

@Deprecated
List<String> getSelectedProjects()

Deprecated.

Since Maven 4: use getProjectActivation().

setExcludedProjects

@Deprecated
MavenExecutionRequest setExcludedProjects(List<String> projects)

Deprecated.

Since Maven 4: use getProjectActivation().

Parameters:

projects - the projects to exclude

Returns:

this MavenExecutionRequest

Since:

3.2

getExcludedProjects

@Deprecated
List<String> getExcludedProjects()

Deprecated.

Since Maven 4: use getProjectActivation().

Returns:

the excluded projects, never null

Since:

3.2

setResume

MavenExecutionRequest setResume(boolean resume)

Sets whether the build should be resumed from the data in the resume.properties file.

Parameters:

resume - Whether or not to resume a previous build.

Returns:

This request, never null.

isResume

boolean isResume()

Returns:

Whether the build should be resumed from the data in the resume.properties file.

setResumeFrom

MavenExecutionRequest setResumeFrom(String project)

getResumeFrom

String getResumeFrom()

setMakeBehavior

MavenExecutionRequest setMakeBehavior(String makeBehavior)

getMakeBehavior

String getMakeBehavior()

setDegreeOfConcurrency

void setDegreeOfConcurrency(int degreeOfConcurrency)

Set's the parallel degree of concurrency used by the build.

Parameters:

degreeOfConcurrency -

getDegreeOfConcurrency

int getDegreeOfConcurrency()

Returns:

the degree of concurrency for the build.

setRecursive

MavenExecutionRequest setRecursive(boolean recursive)

isRecursive

boolean isRecursive()

setPom

MavenExecutionRequest setPom(File pom)

getPom

File getPom()

setShowErrors

MavenExecutionRequest setShowErrors(boolean showErrors)

isShowErrors

boolean isShowErrors()

setTransferListener

MavenExecutionRequest setTransferListener(org.eclipse.aether.transfer.TransferListener transferListener)

getTransferListener

org.eclipse.aether.transfer.TransferListener getTransferListener()

setLoggingLevel

MavenExecutionRequest setLoggingLevel(int loggingLevel)

getLoggingLevel

int getLoggingLevel()

setUpdateSnapshots

MavenExecutionRequest setUpdateSnapshots(boolean updateSnapshots)

isUpdateSnapshots

boolean isUpdateSnapshots()

setNoSnapshotUpdates

MavenExecutionRequest setNoSnapshotUpdates(boolean noSnapshotUpdates)

isNoSnapshotUpdates

boolean isNoSnapshotUpdates()

setGlobalChecksumPolicy

MavenExecutionRequest setGlobalChecksumPolicy(String globalChecksumPolicy)

getGlobalChecksumPolicy

String getGlobalChecksumPolicy()

setLocalRepositoryPath

MavenExecutionRequest setLocalRepositoryPath(String localRepository)

setLocalRepositoryPath

MavenExecutionRequest setLocalRepositoryPath(File localRepository)

getLocalRepositoryPath

File getLocalRepositoryPath()

setLocalRepository

MavenExecutionRequest setLocalRepository(ArtifactRepository repository)

getLocalRepository

ArtifactRepository getLocalRepository()

setInteractiveMode

MavenExecutionRequest setInteractiveMode(boolean interactive)

isInteractiveMode

boolean isInteractiveMode()

setOffline

MavenExecutionRequest setOffline(boolean offline)

isOffline

boolean isOffline()

isCacheTransferError

boolean isCacheTransferError()

setCacheTransferError

MavenExecutionRequest setCacheTransferError(boolean cacheTransferError)

isCacheNotFound

boolean isCacheNotFound()

setCacheNotFound

MavenExecutionRequest setCacheNotFound(boolean cacheNotFound)

getProfiles

List<Profile> getProfiles()

addProfile

MavenExecutionRequest addProfile(Profile profile)

setProfiles

MavenExecutionRequest setProfiles(List<Profile> profiles)

addActiveProfile

@Deprecated
MavenExecutionRequest addActiveProfile(String profile)

Deprecated.

Since Maven 4: use getProfileActivation().

addActiveProfiles

@Deprecated
MavenExecutionRequest addActiveProfiles(List<String> profiles)

Deprecated.

Since Maven 4: use getProfileActivation().

setActiveProfiles

@Deprecated
MavenExecutionRequest setActiveProfiles(List<String> profiles)

Deprecated.

Since Maven 4: use getProfileActivation().

getActiveProfiles

@Deprecated
List<String> getActiveProfiles()

Deprecated.

Since Maven 4: use getProfileActivation().

Returns:

The list of profiles that the user wants to activate.

addInactiveProfile

@Deprecated
MavenExecutionRequest addInactiveProfile(String profile)

Deprecated.

Since Maven 4: use getProfileActivation().

addInactiveProfiles

@Deprecated
MavenExecutionRequest addInactiveProfiles(List<String> profiles)

Deprecated.

Since Maven 4: use getProfileActivation().

setInactiveProfiles

@Deprecated
MavenExecutionRequest setInactiveProfiles(List<String> profiles)

Deprecated.

Since Maven 4: use getProfileActivation().

getInactiveProfiles

@Deprecated
List<String> getInactiveProfiles()

Deprecated.

Since Maven 4: use getProfileActivation().

Returns:

The list of profiles that the user wants to de-activate.

getProjectActivation

ProjectActivation getProjectActivation()

Return the requested activation(s) of project(s) in this execution.

Returns:

requested (de-)activation(s) of project(s) in this execution. Never null.

getProfileActivation

ProfileActivation getProfileActivation()

Return the requested activation(s) of profile(s) in this execution.

Returns:

requested (de-)activation(s) of profile(s) in this execution. Never null.

getProxies

List<Proxy> getProxies()

setProxies

MavenExecutionRequest setProxies(List<Proxy> proxies)

addProxy

MavenExecutionRequest addProxy(Proxy proxy)

getServers

List<Server> getServers()

setServers

MavenExecutionRequest setServers(List<Server> servers)

addServer

MavenExecutionRequest addServer(Server server)

getMirrors

List<Mirror> getMirrors()

setMirrors

MavenExecutionRequest setMirrors(List<Mirror> mirrors)

addMirror

MavenExecutionRequest addMirror(Mirror mirror)

getPluginGroups

List<String> getPluginGroups()

setPluginGroups

MavenExecutionRequest setPluginGroups(List<String> pluginGroups)

addPluginGroup

MavenExecutionRequest addPluginGroup(String pluginGroup)

addPluginGroups

MavenExecutionRequest addPluginGroups(List<String> pluginGroups)

isProjectPresent

boolean isProjectPresent()

setProjectPresent

MavenExecutionRequest setProjectPresent(boolean isProjectPresent)

getUserSettingsFile

File getUserSettingsFile()

setUserSettingsFile

MavenExecutionRequest setUserSettingsFile(File userSettingsFile)

getGlobalSettingsFile

File getGlobalSettingsFile()

setGlobalSettingsFile

MavenExecutionRequest setGlobalSettingsFile(File globalSettingsFile)

addRemoteRepository

MavenExecutionRequest addRemoteRepository(ArtifactRepository repository)

addPluginArtifactRepository

MavenExecutionRequest addPluginArtifactRepository(ArtifactRepository repository)

setRemoteRepositories

MavenExecutionRequest setRemoteRepositories(List<ArtifactRepository> repositories)

Set a new list of remote repositories to use the execution request. This is necessary if you perform transformations on the remote repositories being used. For example if you replace existing repositories with mirrors then it's easier to just replace the whole list with a new list of transformed repositories.

Parameters:

repositories -

Returns:

This request, never null.

getRemoteRepositories

List<ArtifactRepository> getRemoteRepositories()

setPluginArtifactRepositories

MavenExecutionRequest setPluginArtifactRepositories(List<ArtifactRepository> repositories)

getPluginArtifactRepositories

List<ArtifactRepository> getPluginArtifactRepositories()

setRepositoryCache

MavenExecutionRequest setRepositoryCache(org.eclipse.aether.RepositoryCache repositoryCache)

getRepositoryCache

org.eclipse.aether.RepositoryCache getRepositoryCache()

getWorkspaceReader

org.eclipse.aether.repository.WorkspaceReader getWorkspaceReader()

setWorkspaceReader

MavenExecutionRequest setWorkspaceReader(org.eclipse.aether.repository.WorkspaceReader workspaceReader)

getUserToolchainsFile

File getUserToolchainsFile()

setUserToolchainsFile

MavenExecutionRequest setUserToolchainsFile(File userToolchainsFile)

getGlobalToolchainsFile

File getGlobalToolchainsFile()

Returns:

the global toolchains file

Since:

3.3.0

setGlobalToolchainsFile

MavenExecutionRequest setGlobalToolchainsFile(File globalToolchainsFile)

Parameters:

globalToolchainsFile - the global toolchains file

Returns:

this request

Since:

3.3.0

getExecutionListener

ExecutionListener getExecutionListener()

setExecutionListener

MavenExecutionRequest setExecutionListener(ExecutionListener executionListener)

getProjectBuildingRequest

ProjectBuildingRequest getProjectBuildingRequest()

isUseLegacyLocalRepository

@Deprecated
boolean isUseLegacyLocalRepository()

Deprecated.

Since 3.9 there is no direct Maven2 interop offered at LRM level. See Resolver Configuration page option aether.artifactResolver.simpleLrmInterop that provides similar semantics. This method should be never invoked, and always returns false.

Since:

3.1

setUseLegacyLocalRepository

@Deprecated
MavenExecutionRequest setUseLegacyLocalRepository(boolean useLegacyLocalRepository)

Deprecated.

Since 3.9 there is no direct Maven2 interop offered at LRM level. See Resolver Configuration page option aether.artifactResolver.simpleLrmInterop that provides similar semantics. This method should be never invoked, and ignores parameter (value remains always false).

Since:

3.1

setBuilderId

MavenExecutionRequest setBuilderId(String builderId)

Controls the Builder used by Maven by specification of the builder's id.

Since:

3.2.0

getBuilderId

String getBuilderId()

Controls the Builder used by Maven by specification of the builders id.

Since:

3.2.0

setToolchains

MavenExecutionRequest setToolchains(Map<String,List<ToolchainModel>> toolchains)

Parameters:

toolchains - all toolchains grouped by type

Returns:

this request

Since:

3.3.0

getToolchains

Map<String,List<ToolchainModel>> getToolchains()

Returns:

all toolchains grouped by type, never null

Since:

3.3.0

setMultiModuleProjectDirectory

void setMultiModuleProjectDirectory(File file)

Since:

3.3.0

getMultiModuleProjectDirectory

File getMultiModuleProjectDirectory()

Since:

3.3.0

setEventSpyDispatcher

MavenExecutionRequest setEventSpyDispatcher(EventSpyDispatcher eventSpyDispatcher)

Since:

3.3.0

getEventSpyDispatcher

EventSpyDispatcher getEventSpyDispatcher()

Since:

3.3.0

getData

Map<String,Object> getData()

Since:

3.3.0