public class DefaultInvocationRequest extends Object implements InvocationRequest
InvocationRequest.CheckSumPolicy, InvocationRequest.ReactorFailureBehavior
NO_TIMEOUT
Constructor and Description |
---|
DefaultInvocationRequest() |
Modifier and Type | Method and Description |
---|---|
InvocationRequest |
addShellEnvironment(String name,
String value)
Adds the specified environment variable to the Maven invocation.
|
File |
getBaseDirectory()
Gets the path to the base directory of the POM for the Maven invocation.
|
File |
getBaseDirectory(File defaultDirectory)
Gets the path to the base directory of the POM for the Maven invocation.
|
String |
getBuilder()
Get the current set builder strategy id equivalent of
--builder id . |
InvocationOutputHandler |
getErrorHandler(InvocationOutputHandler defaultHandler)
Gets the handler used to capture the error output from the Maven build.
|
InvocationRequest.CheckSumPolicy |
getGlobalChecksumPolicy()
Gets the checksum mode of the Maven invocation.
|
File |
getGlobalSettingsFile()
Gets the path to the global settings for the Maven invocation.
|
File |
getGlobalToolchainsFile()
Alternate path for the global toolchains file Note.
|
List<String> |
getGoals()
Gets the goals for the Maven invocation.
|
InputStream |
getInputStream(InputStream defaultStream)
Gets the input stream used to provide input for the invoked Maven build.
|
File |
getJavaHome()
Gets the path to the base directory of the Java installation used to run Maven.
|
File |
getLocalRepositoryDirectory(File defaultDirectory)
Gets the path to the base directory of the local repository to use for the Maven invocation.
|
String |
getMavenOpts()
Gets the value of the
MAVEN_OPTS environment variable. |
InvocationOutputHandler |
getOutputHandler(InvocationOutputHandler defaultHandler)
Gets the handler used to capture the standard output from the Maven build.
|
File |
getPomFile()
Gets the path to the POM for the Maven invocation.
|
String |
getPomFileName()
Gets the (unqualified) filename of the POM for the Maven invocation.
|
List<String> |
getProfiles()
Gets the profiles for the Maven invocation.
|
List<String> |
getProjects()
A list of specified reactor projects to build instead of all projects.
|
Properties |
getProperties()
Gets the system properties for the Maven invocation.
|
InvocationRequest.ReactorFailureBehavior |
getReactorFailureBehavior()
Gets the failure mode of the Maven invocation.
|
String |
getResumeFrom()
Get the value of
resume-from |
Map<String,String> |
getShellEnvironments()
Gets the environment variables for the Maven invocation.
|
String |
getThreads()
Get the value of the
threads argument. |
int |
getTimeoutInSeconds() |
File |
getToolchainsFile()
Gets the path to the custom toolchains file
|
File |
getUserSettingsFile()
Gets the path to the user settings for the Maven invocation.
|
boolean |
isAlsoMake()
Get the value of the
also-make argument. |
boolean |
isAlsoMakeDependents()
Get the value of the
also-make-dependents |
boolean |
isBatchMode()
By default, Maven is executed in batch mode.
|
boolean |
isDebug()
Gets the debug mode of the Maven invocation.
|
boolean |
isNonPluginUpdates()
Indicates whether Maven should check for plugin updates.
|
boolean |
isOffline()
Gets the network mode of the Maven invocation.
|
boolean |
isRecursive()
Gets the recursion behavior of a reactor invocation.
|
boolean |
isShellEnvironmentInherited()
Indicates whether the environment variables of the current process should be propagated to the Maven invocation.
|
boolean |
isShowErrors()
Gets the exception output mode of the Maven invocation.
|
boolean |
isShowVersion()
The show version behavior (-V option)
|
boolean |
isUpdateSnapshots()
Indicates whether Maven should enforce an update check for plugins and snapshots.
|
InvocationRequest |
setAlsoMake(boolean alsoMake)
Enable the 'also make' mode.
|
InvocationRequest |
setAlsoMakeDependents(boolean alsoMakeDependents)
Enable the 'also make dependents' mode.
|
InvocationRequest |
setBaseDirectory(File basedir)
Sets the path to the base directory of the POM for the Maven invocation.
|
InvocationRequest |
setBatchMode(boolean interactive)
Sets the interaction mode of the Maven invocation.
|
InvocationRequest |
setBuilder(String id)
The id of the build strategy to use.
|
InvocationRequest |
setDebug(boolean debug)
Sets the debug mode of the Maven invocation.
|
InvocationRequest |
setErrorHandler(InvocationOutputHandler errorHandler)
Sets the handler used to capture the error output from the Maven build.
|
InvocationRequest |
setGlobalChecksumPolicy(InvocationRequest.CheckSumPolicy globalChecksumPolicy)
Sets the checksum mode of the Maven invocation.
|
InvocationRequest |
setGlobalSettingsFile(File globalSettings)
Sets the path to the global settings for the Maven invocation.
|
InvocationRequest |
setGlobalToolchainsFile(File toolchains)
Sets the alternate path for the global toolchains file Equivalent of
-gt or --global-toolchains |
InvocationRequest |
setGoals(List<String> goals)
Sets the goals for the Maven invocation.
|
InvocationRequest |
setInputStream(InputStream inputStream)
Sets the input stream used to provide input for the invoked Maven build.
|
InvocationRequest |
setJavaHome(File javaHome)
Sets the path to the base directory of the Java installation used to run Maven.
|
InvocationRequest |
setLocalRepositoryDirectory(File localRepository)
Sets the path to the base directory of the local repository to use for the Maven invocation.
|
InvocationRequest |
setMavenOpts(String mavenOpts)
Sets the value of the
MAVEN_OPTS environment variable. |
InvocationRequest |
setNonPluginUpdates(boolean nonPluginUpdates)
Specifies whether Maven should check for plugin updates.
|
InvocationRequest |
setOffline(boolean offline)
Sets the network mode of the Maven invocation.
|
InvocationRequest |
setOutputHandler(InvocationOutputHandler outputHandler)
Sets the handler used to capture the standard output from the Maven build.
|
InvocationRequest |
setPomFile(File pomFile)
Sets the path to the POM for the Maven invocation.
|
InvocationRequest |
setPomFileName(String pomFilename)
Sets the (unqualified) filename of the POM for the Maven invocation.
|
InvocationRequest |
setProfiles(List<String> profiles)
Sets the profiles for the Maven invocation.
|
InvocationRequest |
setProjects(List<String> projects)
Sets the reactor project list.
|
InvocationRequest |
setProperties(Properties properties)
Sets the system properties for the Maven invocation.
|
InvocationRequest |
setReactorFailureBehavior(InvocationRequest.ReactorFailureBehavior failureBehavior)
Sets the failure mode of the Maven invocation.
|
InvocationRequest |
setRecursive(boolean recursive)
Sets the recursion behavior of a reactor invocation.
|
InvocationRequest |
setResumeFrom(String resumeFrom)
Resume reactor from specified project.
|
InvocationRequest |
setShellEnvironmentInherited(boolean shellEnvironmentInherited)
Specifies whether the environment variables of the current process should be propagated to the Maven invocation.
|
InvocationRequest |
setShowErrors(boolean showErrors)
Sets the exception output mode of the Maven invocation.
|
InvocationRequest |
setShowVersion(boolean showVersion)
enable displaying version without stopping the build Equivalent of
-V or --show-version |
InvocationRequest |
setThreads(String threads)
Thread count, for instance 2.0C where C is core multiplied Equivalent of
-T or --threads |
void |
setTimeoutInSeconds(int timeoutInSeconds) |
InvocationRequest |
setToolchainsFile(File toolchains)
Sets the alternate path for the user toolchains file Equivalent of
-t or --toolchains |
InvocationRequest |
setUpdateSnapshots(boolean updateSnapshots)
Specifies whether Maven should enforce an update check for plugins and snapshots.
|
InvocationRequest |
setUserSettingsFile(File userSettings)
Sets the path to the user settings for the Maven invocation.
|
public File getBaseDirectory()
InvocationRequest
InvocationRequest.getPomFile()
does not return
null
, this setting only affects the working directory for the Maven invocation.getBaseDirectory
in interface InvocationRequest
null
if not set.public File getBaseDirectory(File defaultDirectory)
InvocationRequest
InvocationRequest.getPomFile()
does not return
null
, this setting only affects the working directory for the Maven invocation.getBaseDirectory
in interface InvocationRequest
defaultDirectory
- The default base directory to use if none is configured for this request, may be
null
.null
if not set.public InvocationOutputHandler getErrorHandler(InvocationOutputHandler defaultHandler)
InvocationRequest
getErrorHandler
in interface InvocationRequest
defaultHandler
- the default InvocationOutputHandler
to usenull
if not set.public InvocationRequest.ReactorFailureBehavior getReactorFailureBehavior()
InvocationRequest
InvocationRequest.ReactorFailureBehavior.FailFast
is
used.getReactorFailureBehavior
in interface InvocationRequest
InvocationRequest.ReactorFailureBehavior.FailFast
,
InvocationRequest.ReactorFailureBehavior.FailAtEnd
and InvocationRequest.ReactorFailureBehavior.FailNever
.public List<String> getGoals()
InvocationRequest
getGoals
in interface InvocationRequest
null
if not set.public InputStream getInputStream(InputStream defaultStream)
InvocationRequest
getInputStream
in interface InvocationRequest
defaultStream
- the default InputStream
to usenull
if not set.public File getLocalRepositoryDirectory(File defaultDirectory)
InvocationRequest
getLocalRepositoryDirectory
in interface InvocationRequest
defaultDirectory
- The default location to use if no location is configured for this request, may be
null
.null
to use the location from the
settings.xml
.public InvocationOutputHandler getOutputHandler(InvocationOutputHandler defaultHandler)
InvocationRequest
getOutputHandler
in interface InvocationRequest
defaultHandler
- the default InvocationOutputHandler
to usenull
if not set.public File getPomFile()
InvocationRequest
getPomFile
in interface InvocationRequest
null
if not set.public Properties getProperties()
InvocationRequest
getProperties
in interface InvocationRequest
null
if not set.public boolean isDebug()
InvocationRequest
isDebug
in interface InvocationRequest
true
if Maven should be executed in debug mode, false
if the normal mode should
be used.public boolean isBatchMode()
InvocationRequest
isBatchMode
in interface InvocationRequest
true
if Maven should be executed in batch mode, false
if Maven is executed in
interactive mode.public boolean isOffline()
InvocationRequest
isOffline
in interface InvocationRequest
true
if Maven should be executed in offline mode, false
if the online mode is
used.public boolean isShowErrors()
InvocationRequest
isShowErrors
in interface InvocationRequest
true
if Maven should print stack traces, false
otherwise.public boolean isUpdateSnapshots()
InvocationRequest
isUpdateSnapshots
in interface InvocationRequest
true
if plugins and snapshots should be updated, false
otherwise.public boolean isRecursive()
InvocationRequest
isRecursive
in interface InvocationRequest
true
if sub modules should be build, false
otherwise.public InvocationRequest setRecursive(boolean recursive)
InvocationRequest
-N
and
--non-recursive
setRecursive
in interface InvocationRequest
recursive
- true
if sub modules should be build, false
otherwise.public InvocationRequest setBaseDirectory(File basedir)
InvocationRequest
InvocationRequest.getPomFile()
does not return
null
, this setting only affects the working directory for the Maven invocation.setBaseDirectory
in interface InvocationRequest
basedir
- The path to the base directory of the POM, may be null
if not used.public InvocationRequest setDebug(boolean debug)
InvocationRequest
-X
and --debug
setDebug
in interface InvocationRequest
debug
- true
if Maven should be executed in debug mode, false
if the normal mode
should be used.public InvocationRequest setErrorHandler(InvocationOutputHandler errorHandler)
InvocationRequest
setErrorHandler
in interface InvocationRequest
errorHandler
- The error handler, may be null
if the output is not of interest.public InvocationRequest setReactorFailureBehavior(InvocationRequest.ReactorFailureBehavior failureBehavior)
InvocationRequest
-ff
and --fail-fast
, -fae
and --fail-at-end
, -fn
and --fail-never
setReactorFailureBehavior
in interface InvocationRequest
failureBehavior
- The failure mode, must be one of InvocationRequest.ReactorFailureBehavior.FailFast
,
InvocationRequest.ReactorFailureBehavior.FailAtEnd
and InvocationRequest.ReactorFailureBehavior.FailNever
.public InvocationRequest setGoals(List<String> goals)
InvocationRequest
setGoals
in interface InvocationRequest
goals
- The goals for the Maven invocation, may be null
to execute the POMs default goal.public InvocationRequest setInputStream(InputStream inputStream)
InvocationRequest
setInputStream
in interface InvocationRequest
inputStream
- The input stream used to provide input for the invoked Maven build, may be null
if not required.public InvocationRequest setBatchMode(boolean interactive)
InvocationRequest
-B
and --batch-mode
setBatchMode
in interface InvocationRequest
interactive
- true
if Maven should be executed in non-interactive mode, false
if the
interactive modes is used.public InvocationRequest setLocalRepositoryDirectory(File localRepository)
InvocationRequest
setLocalRepositoryDirectory
in interface InvocationRequest
localRepository
- The path to the base directory of the local repository, may be null
.public InvocationRequest setOffline(boolean offline)
InvocationRequest
-o
and --offline
setOffline
in interface InvocationRequest
offline
- true
if Maven should be executed in offline mode, false
if the online
mode is used.public InvocationRequest setOutputHandler(InvocationOutputHandler outputHandler)
InvocationRequest
setOutputHandler
in interface InvocationRequest
outputHandler
- The output handler, may be null
if the output is not of interest.public InvocationRequest setPomFile(File pomFile)
InvocationRequest
setPomFile
in interface InvocationRequest
pomFile
- The path to the POM for the Maven invocation, may be null
if not used.public InvocationRequest setProperties(Properties properties)
InvocationRequest
setProperties
in interface InvocationRequest
properties
- The system properties for the Maven invocation, may be null
if not set.public InvocationRequest setShowErrors(boolean showErrors)
InvocationRequest
-e
and --errors
setShowErrors
in interface InvocationRequest
showErrors
- true
if Maven should print stack traces, false
otherwise.public InvocationRequest setUpdateSnapshots(boolean updateSnapshots)
InvocationRequest
-U
and
--update-snapshots
setUpdateSnapshots
in interface InvocationRequest
updateSnapshots
- true
if plugins and snapshots should be updated, false
otherwise.public boolean isShellEnvironmentInherited()
InvocationRequest
isShellEnvironmentInherited
in interface InvocationRequest
true
if the environment variables should be propagated, false
otherwise.MavenCommandLineBuilder.setShellEnvironment(InvocationRequest, Commandline)
public InvocationRequest setShellEnvironmentInherited(boolean shellEnvironmentInherited)
InvocationRequest
setShellEnvironmentInherited
in interface InvocationRequest
shellEnvironmentInherited
- true
if the environment variables should be propagated,
false
otherwise.public File getJavaHome()
InvocationRequest
getJavaHome
in interface InvocationRequest
null
to use the
default Java home.public InvocationRequest setJavaHome(File javaHome)
setJavaHome
in interface InvocationRequest
javaHome
- The path to the base directory of the Java installation used to run Maven, may be
null
to use the default Java home.public File getUserSettingsFile()
getUserSettingsFile
in interface InvocationRequest
null
to load the user settings
from the default location.public InvocationRequest setUserSettingsFile(File userSettings)
-s
and --settings
setUserSettingsFile
in interface InvocationRequest
userSettings
- The path to the user settings for the Maven invocation, may be null
to load the
user settings from the default location.public File getGlobalSettingsFile()
getGlobalSettingsFile
in interface InvocationRequest
null
to load the global settings
from the default location.public InvocationRequest setGlobalSettingsFile(File globalSettings)
-gs
and
--global-settings
setGlobalSettingsFile
in interface InvocationRequest
globalSettings
- The path to the global settings for the Maven invocation, may be null
to load
the global settings from the default location.public File getToolchainsFile()
getToolchainsFile
in interface InvocationRequest
null
to load the toolchains from the default
locationpublic InvocationRequest setToolchainsFile(File toolchains)
-t
or --toolchains
setToolchainsFile
in interface InvocationRequest
toolchains
- the alternate path for the user toolchains filepublic File getGlobalToolchainsFile()
getGlobalToolchainsFile
in interface InvocationRequest
null
to load the global toolchains from the
default location.public InvocationRequest setGlobalToolchainsFile(File toolchains)
-gt
or --global-toolchains
setGlobalToolchainsFile
in interface InvocationRequest
toolchains
- the alternate path for the global toolchains filepublic InvocationRequest.CheckSumPolicy getGlobalChecksumPolicy()
getGlobalChecksumPolicy
in interface InvocationRequest
InvocationRequest.CheckSumPolicy.Warn
and InvocationRequest.CheckSumPolicy.Fail
.public InvocationRequest setGlobalChecksumPolicy(InvocationRequest.CheckSumPolicy globalChecksumPolicy)
-c
or --lax-checksums
, -C
or --strict-checksums
setGlobalChecksumPolicy
in interface InvocationRequest
globalChecksumPolicy
- The checksum mode, must be one of InvocationRequest.CheckSumPolicy.Warn
and
InvocationRequest.CheckSumPolicy.Fail
.public String getPomFileName()
InvocationRequest.getPomFile()
does not return null
. Otherwise, the base directory is assumed to contain a
POM with this name. By default, a file named pom.xml
is used.getPomFileName
in interface InvocationRequest
null
if not set.public InvocationRequest setPomFileName(String pomFilename)
InvocationRequest.getPomFile()
does not return null
. Otherwise, the base directory is assumed to contain a
POM with this name.setPomFileName
in interface InvocationRequest
pomFilename
- The (unqualified) filename of the POM for the Maven invocation, may be null
if
not used.public List<String> getProfiles()
getProfiles
in interface InvocationRequest
null
if not set.public InvocationRequest setProfiles(List<String> profiles)
-P
and --active-profiles
setProfiles
in interface InvocationRequest
profiles
- The profiles for the Maven invocation, may be null
to use the default profiles.public boolean isNonPluginUpdates()
isNonPluginUpdates
in interface InvocationRequest
true
if plugin updates should be suppressed, false
otherwise.public InvocationRequest setNonPluginUpdates(boolean nonPluginUpdates)
Equivalent of -npu
or --no-plugin-updates
note: Ineffective with Maven3, only kept for backward compatibility
setNonPluginUpdates
in interface InvocationRequest
nonPluginUpdates
- true
if plugin updates should be suppressed, false
otherwise.public InvocationRequest addShellEnvironment(String name, String value)
InvocationRequest
addShellEnvironment
in interface InvocationRequest
name
- The name of the environment variable, must not be null
.value
- The value of the environment variable, must not be null
.public Map<String,String> getShellEnvironments()
InvocationRequest
getShellEnvironments
in interface InvocationRequest
null
if not set.public String getMavenOpts()
InvocationRequest
MAVEN_OPTS
environment variable.getMavenOpts
in interface InvocationRequest
MAVEN_OPTS
environment variable or null
if not set.public InvocationRequest setMavenOpts(String mavenOpts)
InvocationRequest
MAVEN_OPTS
environment variable.setMavenOpts
in interface InvocationRequest
mavenOpts
- The value of the MAVEN_OPTS
environment variable, may be null
to use
the default options.public boolean isShowVersion()
InvocationRequest
isShowVersion
in interface InvocationRequest
InvocationRequest.isShowVersion()
public InvocationRequest setShowVersion(boolean showVersion)
InvocationRequest
-V
or --show-version
setShowVersion
in interface InvocationRequest
showVersion
- enable displaying versionInvocationRequest.setShowVersion(boolean)
public String getThreads()
threads
argument.getThreads
in interface InvocationRequest
threads
argument or null
if not setpublic InvocationRequest setThreads(String threads)
-T
or --threads
note: available since Maven3
setThreads
in interface InvocationRequest
threads
- the threadcountpublic List<String> getProjects()
getProjects
in interface InvocationRequest
null
public InvocationRequest setProjects(List<String> projects)
-pl
or --projects
setProjects
in interface InvocationRequest
projects
- the reactor project listpublic boolean isAlsoMake()
also-make
argument.isAlsoMake
in interface InvocationRequest
true
if the argument also-make
was specified, otherwise false
public InvocationRequest setAlsoMake(boolean alsoMake)
-am
or --also-make
setAlsoMake
in interface InvocationRequest
alsoMake
- enable 'also make' modepublic boolean isAlsoMakeDependents()
also-make-dependents
isAlsoMakeDependents
in interface InvocationRequest
true
if the argument also-make-dependents
was specified, otherwise false
public InvocationRequest setAlsoMakeDependents(boolean alsoMakeDependents)
-amd
or --also-make-dependents
setAlsoMakeDependents
in interface InvocationRequest
alsoMakeDependents
- enable 'also make' modepublic String getResumeFrom()
resume-from
getResumeFrom
in interface InvocationRequest
public InvocationRequest setResumeFrom(String resumeFrom)
-rf
or --resume-from
setResumeFrom
in interface InvocationRequest
resumeFrom
- set the project to resume frompublic InvocationRequest setBuilder(String id)
--builder id
. Note. This is available since Maven
3.2.1setBuilder
in interface InvocationRequest
id
- The builder id.InvocationRequest
FIXME: How to identify if this is a valid command line option?public String getBuilder()
--builder id
. Note. This is available since
Maven 3.2.1getBuilder
in interface InvocationRequest
public int getTimeoutInSeconds()
getTimeoutInSeconds
in interface InvocationRequest
public void setTimeoutInSeconds(int timeoutInSeconds)
setTimeoutInSeconds
in interface InvocationRequest
timeoutInSeconds
- the timeout in seconds to execute the projectCopyright © 2002–2018 The Apache Software Foundation. All rights reserved.