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 java.lang.StringCHECKSUM_POLICY_FAILstatic java.lang.StringCHECKSUM_POLICY_WARNstatic intLOGGING_LEVEL_DEBUGstatic intLOGGING_LEVEL_DISABLEDstatic intLOGGING_LEVEL_ERRORstatic intLOGGING_LEVEL_FATALstatic intLOGGING_LEVEL_INFOstatic intLOGGING_LEVEL_WARNstatic java.lang.StringREACTOR_FAIL_AT_ENDstatic java.lang.StringREACTOR_FAIL_FASTstatic java.lang.StringREACTOR_FAIL_NEVERstatic java.lang.StringREACTOR_MAKE_BOTHstatic java.lang.StringREACTOR_MAKE_DOWNSTREAMstatic java.lang.StringREACTOR_MAKE_UPSTREAM
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description MavenExecutionRequestaddActiveProfile(java.lang.String profile)MavenExecutionRequestaddActiveProfiles(java.util.List<java.lang.String> profiles)MavenExecutionRequestaddInactiveProfile(java.lang.String profile)MavenExecutionRequestaddInactiveProfiles(java.util.List<java.lang.String> profiles)MavenExecutionRequestaddMirror(org.apache.maven.settings.Mirror mirror)MavenExecutionRequestaddPluginArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)MavenExecutionRequestaddPluginGroup(java.lang.String pluginGroup)MavenExecutionRequestaddPluginGroups(java.util.List<java.lang.String> pluginGroups)MavenExecutionRequestaddProfile(org.apache.maven.model.Profile profile)MavenExecutionRequestaddProxy(org.apache.maven.settings.Proxy proxy)MavenExecutionRequestaddRemoteRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)MavenExecutionRequestaddServer(org.apache.maven.settings.Server server)java.util.List<java.lang.String>getActiveProfiles()java.lang.StringgetBaseDirectory()java.lang.StringgetBuilderId()Controls theBuilderused by Maven by specification of the builders id.java.util.Map<java.lang.String,java.lang.Object>getData()intgetDegreeOfConcurrency()EventSpyDispatchergetEventSpyDispatcher()java.util.List<java.lang.String>getExcludedProjects()ExecutionListenergetExecutionListener()java.lang.StringgetGlobalChecksumPolicy()java.io.FilegetGlobalSettingsFile()java.io.FilegetGlobalToolchainsFile()java.util.List<java.lang.String>getGoals()java.util.List<java.lang.String>getInactiveProfiles()org.apache.maven.artifact.repository.ArtifactRepositorygetLocalRepository()java.io.FilegetLocalRepositoryPath()intgetLoggingLevel()java.lang.StringgetMakeBehavior()java.util.List<org.apache.maven.settings.Mirror>getMirrors()java.io.FilegetMultiModuleProjectDirectory()java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>getPluginArtifactRepositories()java.util.List<java.lang.String>getPluginGroups()java.io.FilegetPom()java.util.List<org.apache.maven.model.Profile>getProfiles()ProjectBuildingRequestgetProjectBuildingRequest()java.util.List<org.apache.maven.settings.Proxy>getProxies()java.lang.StringgetReactorFailureBehavior()java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>getRemoteRepositories()org.eclipse.aether.RepositoryCachegetRepositoryCache()java.lang.StringgetResumeFrom()java.util.List<java.lang.String>getSelectedProjects()java.util.List<org.apache.maven.settings.Server>getServers()java.util.DategetStartTime()java.util.PropertiesgetSystemProperties()Gets the system properties to use for interpolation and profile activation.java.util.Map<java.lang.String,java.util.List<ToolchainModel>>getToolchains()org.eclipse.aether.transfer.TransferListenergetTransferListener()java.util.PropertiesgetUserProperties()Gets the user properties to use for interpolation and profile activation.java.io.FilegetUserSettingsFile()java.io.FilegetUserToolchainsFile()org.eclipse.aether.repository.WorkspaceReadergetWorkspaceReader()booleanisCacheNotFound()booleanisCacheTransferError()booleanisIgnoreTransitiveRepositories()booleanisInteractiveMode()booleanisNoSnapshotUpdates()booleanisOffline()booleanisProjectPresent()booleanisRecursive()booleanisShowErrors()booleanisUpdateSnapshots()booleanisUseLegacyLocalRepository()Deprecated.Since 3.9 there is no direct Maven2 interop offered at LRM level.MavenExecutionRequestsetActiveProfiles(java.util.List<java.lang.String> profiles)MavenExecutionRequestsetBaseDirectory(java.io.File basedir)MavenExecutionRequestsetBuilderId(java.lang.String builderId)Controls theBuilderused by Maven by specification of the builder's id.MavenExecutionRequestsetCacheNotFound(boolean cacheNotFound)MavenExecutionRequestsetCacheTransferError(boolean cacheTransferError)voidsetDegreeOfConcurrency(int degreeOfConcurrency)Set's the parallel degree of concurrency used by the build.MavenExecutionRequestsetEventSpyDispatcher(EventSpyDispatcher eventSpyDispatcher)MavenExecutionRequestsetExcludedProjects(java.util.List<java.lang.String> projects)MavenExecutionRequestsetExecutionListener(ExecutionListener executionListener)MavenExecutionRequestsetGlobalChecksumPolicy(java.lang.String globalChecksumPolicy)MavenExecutionRequestsetGlobalSettingsFile(java.io.File globalSettingsFile)MavenExecutionRequestsetGlobalToolchainsFile(java.io.File globalToolchainsFile)MavenExecutionRequestsetGoals(java.util.List<java.lang.String> goals)MavenExecutionRequestsetIgnoreTransitiveRepositories(boolean ignoreTransitiveRepositories)MavenExecutionRequestsetInactiveProfiles(java.util.List<java.lang.String> profiles)MavenExecutionRequestsetInteractiveMode(boolean interactive)MavenExecutionRequestsetLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)MavenExecutionRequestsetLocalRepositoryPath(java.io.File localRepository)MavenExecutionRequestsetLocalRepositoryPath(java.lang.String localRepository)MavenExecutionRequestsetLoggingLevel(int loggingLevel)MavenExecutionRequestsetMakeBehavior(java.lang.String makeBehavior)MavenExecutionRequestsetMirrors(java.util.List<org.apache.maven.settings.Mirror> mirrors)voidsetMultiModuleProjectDirectory(java.io.File file)MavenExecutionRequestsetNoSnapshotUpdates(boolean noSnapshotUpdates)MavenExecutionRequestsetOffline(boolean offline)MavenExecutionRequestsetPluginArtifactRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories)MavenExecutionRequestsetPluginGroups(java.util.List<java.lang.String> pluginGroups)MavenExecutionRequestsetPom(java.io.File pom)MavenExecutionRequestsetProfiles(java.util.List<org.apache.maven.model.Profile> profiles)MavenExecutionRequestsetProjectPresent(boolean isProjectPresent)MavenExecutionRequestsetProxies(java.util.List<org.apache.maven.settings.Proxy> proxies)MavenExecutionRequestsetReactorFailureBehavior(java.lang.String failureBehavior)MavenExecutionRequestsetRecursive(boolean recursive)MavenExecutionRequestsetRemoteRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories)Set a new list of remote repositories to use the execution request.MavenExecutionRequestsetRepositoryCache(org.eclipse.aether.RepositoryCache repositoryCache)MavenExecutionRequestsetResumeFrom(java.lang.String project)MavenExecutionRequestsetSelectedProjects(java.util.List<java.lang.String> projects)MavenExecutionRequestsetServers(java.util.List<org.apache.maven.settings.Server> servers)MavenExecutionRequestsetShowErrors(boolean showErrors)MavenExecutionRequestsetStartTime(java.util.Date start)MavenExecutionRequestsetSystemProperties(java.util.Properties systemProperties)Sets the system properties to use for interpolation and profile activation.MavenExecutionRequestsetToolchains(java.util.Map<java.lang.String,java.util.List<ToolchainModel>> toolchains)MavenExecutionRequestsetTransferListener(org.eclipse.aether.transfer.TransferListener transferListener)MavenExecutionRequestsetUpdateSnapshots(boolean updateSnapshots)MavenExecutionRequestsetUseLegacyLocalRepository(boolean useLegacyLocalRepository)Deprecated.Since 3.9 there is no direct Maven2 interop offered at LRM level.MavenExecutionRequestsetUserProperties(java.util.Properties userProperties)Sets the user properties to use for interpolation and profile activation.MavenExecutionRequestsetUserSettingsFile(java.io.File userSettingsFile)MavenExecutionRequestsetUserToolchainsFile(java.io.File userToolchainsFile)MavenExecutionRequestsetWorkspaceReader(org.eclipse.aether.repository.WorkspaceReader workspaceReader)
-
-
-
Field Detail
-
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 java.lang.String REACTOR_FAIL_FAST
- See Also:
- Constant Field Values
-
REACTOR_FAIL_AT_END
static final java.lang.String REACTOR_FAIL_AT_END
- See Also:
- Constant Field Values
-
REACTOR_FAIL_NEVER
static final java.lang.String REACTOR_FAIL_NEVER
- See Also:
- Constant Field Values
-
REACTOR_MAKE_UPSTREAM
static final java.lang.String REACTOR_MAKE_UPSTREAM
- See Also:
- Constant Field Values
-
REACTOR_MAKE_DOWNSTREAM
static final java.lang.String REACTOR_MAKE_DOWNSTREAM
- See Also:
- Constant Field Values
-
REACTOR_MAKE_BOTH
static final java.lang.String REACTOR_MAKE_BOTH
- See Also:
- Constant Field Values
-
CHECKSUM_POLICY_FAIL
static final java.lang.String CHECKSUM_POLICY_FAIL
- See Also:
- Constant Field Values
-
CHECKSUM_POLICY_WARN
static final java.lang.String CHECKSUM_POLICY_WARN
- See Also:
- Constant Field Values
-
-
Method Detail
-
setBaseDirectory
MavenExecutionRequest setBaseDirectory(java.io.File basedir)
-
getBaseDirectory
java.lang.String getBaseDirectory()
-
setStartTime
MavenExecutionRequest setStartTime(java.util.Date start)
-
getStartTime
java.util.Date getStartTime()
-
setGoals
MavenExecutionRequest setGoals(java.util.List<java.lang.String> goals)
-
getGoals
java.util.List<java.lang.String> getGoals()
-
setSystemProperties
MavenExecutionRequest setSystemProperties(java.util.Properties systemProperties)
Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()and environment variables.- Parameters:
systemProperties- The system properties, may benull.- Returns:
- This request, never
null.
-
getSystemProperties
java.util.Properties getSystemProperties()
Gets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()and environment variables.- Returns:
- The system properties, never
null.
-
setUserProperties
MavenExecutionRequest setUserProperties(java.util.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=valueparameter on the command line.- Parameters:
userProperties- The user properties, may benull.- Returns:
- This request, never
null.
-
getUserProperties
java.util.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=valueparameter on the command line.- Returns:
- The user properties, never
null.
-
setReactorFailureBehavior
MavenExecutionRequest setReactorFailureBehavior(java.lang.String failureBehavior)
-
getReactorFailureBehavior
java.lang.String getReactorFailureBehavior()
-
setSelectedProjects
MavenExecutionRequest setSelectedProjects(java.util.List<java.lang.String> projects)
-
getSelectedProjects
java.util.List<java.lang.String> getSelectedProjects()
-
setExcludedProjects
MavenExecutionRequest setExcludedProjects(java.util.List<java.lang.String> projects)
- Parameters:
projects- the projects to exclude- Returns:
- this MavenExecutionRequest
- Since:
- 3.2
-
getExcludedProjects
java.util.List<java.lang.String> getExcludedProjects()
- Returns:
- the excluded projects, never
null - Since:
- 3.2
-
setResumeFrom
MavenExecutionRequest setResumeFrom(java.lang.String project)
-
getResumeFrom
java.lang.String getResumeFrom()
-
setMakeBehavior
MavenExecutionRequest setMakeBehavior(java.lang.String makeBehavior)
-
getMakeBehavior
java.lang.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(java.io.File pom)
-
getPom
java.io.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(java.lang.String globalChecksumPolicy)
-
getGlobalChecksumPolicy
java.lang.String getGlobalChecksumPolicy()
-
setLocalRepositoryPath
MavenExecutionRequest setLocalRepositoryPath(java.lang.String localRepository)
-
setLocalRepositoryPath
MavenExecutionRequest setLocalRepositoryPath(java.io.File localRepository)
-
getLocalRepositoryPath
java.io.File getLocalRepositoryPath()
-
setLocalRepository
MavenExecutionRequest setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)
-
getLocalRepository
org.apache.maven.artifact.repository.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)
-
isIgnoreTransitiveRepositories
boolean isIgnoreTransitiveRepositories()
- Since:
- 3.9.7
-
setIgnoreTransitiveRepositories
MavenExecutionRequest setIgnoreTransitiveRepositories(boolean ignoreTransitiveRepositories)
- Since:
- 3.9.7
-
getProfiles
java.util.List<org.apache.maven.model.Profile> getProfiles()
-
addProfile
MavenExecutionRequest addProfile(org.apache.maven.model.Profile profile)
-
setProfiles
MavenExecutionRequest setProfiles(java.util.List<org.apache.maven.model.Profile> profiles)
-
addActiveProfile
MavenExecutionRequest addActiveProfile(java.lang.String profile)
-
addActiveProfiles
MavenExecutionRequest addActiveProfiles(java.util.List<java.lang.String> profiles)
-
setActiveProfiles
MavenExecutionRequest setActiveProfiles(java.util.List<java.lang.String> profiles)
-
getActiveProfiles
java.util.List<java.lang.String> getActiveProfiles()
-
addInactiveProfile
MavenExecutionRequest addInactiveProfile(java.lang.String profile)
-
addInactiveProfiles
MavenExecutionRequest addInactiveProfiles(java.util.List<java.lang.String> profiles)
-
setInactiveProfiles
MavenExecutionRequest setInactiveProfiles(java.util.List<java.lang.String> profiles)
-
getInactiveProfiles
java.util.List<java.lang.String> getInactiveProfiles()
-
getProxies
java.util.List<org.apache.maven.settings.Proxy> getProxies()
-
setProxies
MavenExecutionRequest setProxies(java.util.List<org.apache.maven.settings.Proxy> proxies)
-
addProxy
MavenExecutionRequest addProxy(org.apache.maven.settings.Proxy proxy)
-
getServers
java.util.List<org.apache.maven.settings.Server> getServers()
-
setServers
MavenExecutionRequest setServers(java.util.List<org.apache.maven.settings.Server> servers)
-
addServer
MavenExecutionRequest addServer(org.apache.maven.settings.Server server)
-
getMirrors
java.util.List<org.apache.maven.settings.Mirror> getMirrors()
-
setMirrors
MavenExecutionRequest setMirrors(java.util.List<org.apache.maven.settings.Mirror> mirrors)
-
addMirror
MavenExecutionRequest addMirror(org.apache.maven.settings.Mirror mirror)
-
getPluginGroups
java.util.List<java.lang.String> getPluginGroups()
-
setPluginGroups
MavenExecutionRequest setPluginGroups(java.util.List<java.lang.String> pluginGroups)
-
addPluginGroup
MavenExecutionRequest addPluginGroup(java.lang.String pluginGroup)
-
addPluginGroups
MavenExecutionRequest addPluginGroups(java.util.List<java.lang.String> pluginGroups)
-
isProjectPresent
boolean isProjectPresent()
-
setProjectPresent
MavenExecutionRequest setProjectPresent(boolean isProjectPresent)
-
getUserSettingsFile
java.io.File getUserSettingsFile()
-
setUserSettingsFile
MavenExecutionRequest setUserSettingsFile(java.io.File userSettingsFile)
-
getGlobalSettingsFile
java.io.File getGlobalSettingsFile()
-
setGlobalSettingsFile
MavenExecutionRequest setGlobalSettingsFile(java.io.File globalSettingsFile)
-
addRemoteRepository
MavenExecutionRequest addRemoteRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)
-
addPluginArtifactRepository
MavenExecutionRequest addPluginArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)
-
setRemoteRepositories
MavenExecutionRequest setRemoteRepositories(java.util.List<org.apache.maven.artifact.repository.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
java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()
-
setPluginArtifactRepositories
MavenExecutionRequest setPluginArtifactRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories)
-
getPluginArtifactRepositories
java.util.List<org.apache.maven.artifact.repository.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
java.io.File getUserToolchainsFile()
-
setUserToolchainsFile
MavenExecutionRequest setUserToolchainsFile(java.io.File userToolchainsFile)
-
getGlobalToolchainsFile
java.io.File getGlobalToolchainsFile()
- Returns:
- the global toolchains file
- Since:
- 3.3.0
-
setGlobalToolchainsFile
MavenExecutionRequest setGlobalToolchainsFile(java.io.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 optionaether.artifactResolver.simpleLrmInteropthat provides similar semantics. This method should be never invoked, and always returnsfalse.- 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 optionaether.artifactResolver.simpleLrmInteropthat provides similar semantics. This method should be never invoked, and ignores parameter (value remains alwaysfalse).- Since:
- 3.1
-
setBuilderId
MavenExecutionRequest setBuilderId(java.lang.String builderId)
Controls theBuilderused by Maven by specification of the builder's id.- Since:
- 3.2.0
-
getBuilderId
java.lang.String getBuilderId()
Controls theBuilderused by Maven by specification of the builders id.- Since:
- 3.2.0
-
setToolchains
MavenExecutionRequest setToolchains(java.util.Map<java.lang.String,java.util.List<ToolchainModel>> toolchains)
- Parameters:
toolchains- all toolchains grouped by type- Returns:
- this request
- Since:
- 3.3.0
-
getToolchains
java.util.Map<java.lang.String,java.util.List<ToolchainModel>> getToolchains()
- Returns:
- all toolchains grouped by type, never
null - Since:
- 3.3.0
-
setMultiModuleProjectDirectory
void setMultiModuleProjectDirectory(java.io.File file)
- Since:
- 3.3.0
-
getMultiModuleProjectDirectory
java.io.File getMultiModuleProjectDirectory()
- Since:
- 3.3.0
-
setEventSpyDispatcher
MavenExecutionRequest setEventSpyDispatcher(EventSpyDispatcher eventSpyDispatcher)
- Since:
- 3.3.0
-
getEventSpyDispatcher
EventSpyDispatcher getEventSpyDispatcher()
- Since:
- 3.3.0
-
getData
java.util.Map<java.lang.String,java.lang.Object> getData()
- Since:
- 3.3.0
-
-