public interface InvocationRequest
| Modifier and Type | Interface and Description | 
|---|---|
| static class  | InvocationRequest.CheckSumPolicyThe kind of checksum policy which should be used during Maven invocation. | 
| static class  | InvocationRequest.ReactorFailureBehaviorThe reactor failure behavior which to be used during Maven invocation. | 
| Modifier and Type | Field and Description | 
|---|---|
| static int | NO_TIMEOUT | 
| 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_OPTSenvironment 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  threadsargument. | 
| 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-makeargument. | 
| 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 batchMode)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  -gtor--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_OPTSenvironment 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  -Vor--show-version | 
| InvocationRequest | setThreads(String threads)Thread count, for instance 2.0C where C is core multiplied Equivalent of  -Tor--threads | 
| void | setTimeoutInSeconds(int timeoutInSeconds) | 
| InvocationRequest | setToolchainsFile(File toolchains)Sets the alternate path for the user toolchains file Equivalent of  -tor--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. | 
static final int NO_TIMEOUT
boolean isBatchMode()
true if Maven should be executed in batch mode, false if Maven is executed in
         interactive mode.boolean isOffline()
true if Maven should be executed in offline mode, false if the online mode is
         used.boolean isUpdateSnapshots()
true if plugins and snapshots should be updated, false otherwise.boolean isRecursive()
true if sub modules should be build, false otherwise.List<String> getProjects()
nullboolean isAlsoMake()
also-make argument.true if the argument also-make was specified, otherwise falseboolean isAlsoMakeDependents()
also-make-dependentstrue if the argument also-make-dependents was specified, otherwise falseString getResumeFrom()
resume-fromboolean isDebug()
true if Maven should be executed in debug mode, false if the normal mode should
         be used.boolean isShowErrors()
true if Maven should print stack traces, false otherwise.boolean isShellEnvironmentInherited()
true if the environment variables should be propagated, false otherwise.boolean isNonPluginUpdates()
true if plugin updates should be suppressed, false otherwise.InvocationRequest.ReactorFailureBehavior getReactorFailureBehavior()
InvocationRequest.ReactorFailureBehavior.FailFast is
 used.InvocationRequest.ReactorFailureBehavior.FailFast,
         InvocationRequest.ReactorFailureBehavior.FailAtEnd and InvocationRequest.ReactorFailureBehavior.FailNever.File getLocalRepositoryDirectory(File defaultDirectory)
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.InputStream getInputStream(InputStream defaultStream)
defaultStream - the default InputStream to usenull if not set.InvocationOutputHandler getOutputHandler(InvocationOutputHandler defaultHandler)
defaultHandler - the default InvocationOutputHandler to usenull if not set.InvocationOutputHandler getErrorHandler(InvocationOutputHandler defaultHandler)
defaultHandler - the default InvocationOutputHandler to usenull if not set.File getPomFile()
null if not set.String getPomFileName()
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.null if not set.File getBaseDirectory()
getPomFile() does not return
 null, this setting only affects the working directory for the Maven invocation.null if not set.File getBaseDirectory(File defaultDirectory)
getPomFile() does not return
 null, this setting only affects the working directory for the Maven invocation.defaultDirectory - The default base directory to use if none is configured for this request, may be
            null.null if not set.File getJavaHome()
null to use the
         default Java home.Properties getProperties()
null if not set.List<String> getGoals()
null if not set.File getUserSettingsFile()
null to load the user settings
         from the default location.File getGlobalSettingsFile()
null to load the global settings
         from the default location.File getToolchainsFile()
null to load the toolchains from the default
         locationFile getGlobalToolchainsFile()
null to load the global toolchains from the
         default location.InvocationRequest.CheckSumPolicy getGlobalChecksumPolicy()
InvocationRequest.CheckSumPolicy.Warn and InvocationRequest.CheckSumPolicy.Fail.List<String> getProfiles()
null if not set.Map<String,String> getShellEnvironments()
null if not set.String getMavenOpts()
MAVEN_OPTS environment variable.MAVEN_OPTS environment variable or null if not set.boolean isShowVersion()
String getThreads()
threads argument.threads argument or null if not setInvocationRequest setBatchMode(boolean batchMode)
-B and --batch-modebatchMode - true if Maven should be executed in non-interactive mode, false if the
            interactive modes is used.InvocationRequest setOffline(boolean offline)
-o and --offlineoffline - true if Maven should be executed in offline mode, false if the online
            mode is used.InvocationRequest setDebug(boolean debug)
-X and --debugdebug - true if Maven should be executed in debug mode, false if the normal mode
            should be used.InvocationRequest setShowErrors(boolean showErrors)
-e and --errorsshowErrors - true if Maven should print stack traces, false otherwise.InvocationRequest setUpdateSnapshots(boolean updateSnapshots)
-U and
 --update-snapshotsupdateSnapshots - true if plugins and snapshots should be updated, false
            otherwise.InvocationRequest setReactorFailureBehavior(InvocationRequest.ReactorFailureBehavior failureBehavior)
-ff and --fail-fast, -fae
 and --fail-at-end, -fn and --fail-neverfailureBehavior - The failure mode, must be one of InvocationRequest.ReactorFailureBehavior.FailFast,
            InvocationRequest.ReactorFailureBehavior.FailAtEnd and InvocationRequest.ReactorFailureBehavior.FailNever.InvocationRequest setLocalRepositoryDirectory(File localRepository)
localRepository - The path to the base directory of the local repository, may be null.InvocationRequest setInputStream(InputStream inputStream)
inputStream - The input stream used to provide input for the invoked Maven build, may be null
            if not required.InvocationRequest setOutputHandler(InvocationOutputHandler outputHandler)
outputHandler - The output handler, may be null if the output is not of interest.InvocationRequest setErrorHandler(InvocationOutputHandler errorHandler)
errorHandler - The error handler, may be null if the output is not of interest.InvocationRequest setPomFile(File pomFile)
pomFile - The path to the POM for the Maven invocation, may be null if not used.InvocationRequest setPomFileName(String pomFilename)
getPomFile() does not return null. Otherwise, the base directory is assumed to contain a
 POM with this name.pomFilename - The (unqualified) filename of the POM for the Maven invocation, may be null if
            not used.InvocationRequest setBaseDirectory(File basedir)
getPomFile() does not return
 null, this setting only affects the working directory for the Maven invocation.basedir - The path to the base directory of the POM, may be null if not used.InvocationRequest setJavaHome(File javaHome)
javaHome - The path to the base directory of the Java installation used to run Maven, may be
            null to use the default Java home.InvocationRequest setProperties(Properties properties)
properties - The system properties for the Maven invocation, may be null if not set.InvocationRequest setGoals(List<String> goals)
goals - The goals for the Maven invocation, may be null to execute the POMs default goal.InvocationRequest setProfiles(List<String> profiles)
-P and --active-profilesprofiles - The profiles for the Maven invocation, may be null to use the default profiles.InvocationRequest setShellEnvironmentInherited(boolean shellEnvironmentInherited)
shellEnvironmentInherited - true if the environment variables should be propagated,
            false otherwise.InvocationRequest setUserSettingsFile(File userSettings)
-s and --settingsuserSettings - The path to the user settings for the Maven invocation, may be null to load the
            user settings from the default location.InvocationRequest setGlobalSettingsFile(File globalSettings)
-gs and
 --global-settingsglobalSettings - The path to the global settings for the Maven invocation, may be null to load
            the global settings from the default location.InvocationRequest setToolchainsFile(File toolchains)
-t or --toolchainstoolchains - the alternate path for the user toolchains fileInvocationRequest setGlobalToolchainsFile(File toolchains)
-gt or --global-toolchainstoolchains - the alternate path for the global toolchains fileInvocationRequest setGlobalChecksumPolicy(InvocationRequest.CheckSumPolicy globalChecksumPolicy)
-c or --lax-checksums, -C
 or --strict-checksumsglobalChecksumPolicy - The checksum mode, must be one of InvocationRequest.CheckSumPolicy.Warn and
            InvocationRequest.CheckSumPolicy.Fail.InvocationRequest setNonPluginUpdates(boolean nonPluginUpdates)
 Equivalent of -npu or --no-plugin-updates
 
note: Ineffective with Maven3, only kept for backward compatibility
nonPluginUpdates - true if plugin updates should be suppressed, false otherwise.InvocationRequest setRecursive(boolean recursive)
-N and
 --non-recursiverecursive - true if sub modules should be build, false otherwise.InvocationRequest addShellEnvironment(String name, String value)
name - The name of the environment variable, must not be null.value - The value of the environment variable, must not be null.InvocationRequest setMavenOpts(String mavenOpts)
MAVEN_OPTS environment variable.mavenOpts - The value of the MAVEN_OPTS environment variable, may be null to use
            the default options.InvocationRequest setShowVersion(boolean showVersion)
-V or --show-versionshowVersion - enable displaying versionInvocationRequest setThreads(String threads)
-T or --threads
 note: available since Maven3
threads - the threadcountInvocationRequest setProjects(List<String> projects)
-pl or --projectsprojects - the reactor project listInvocationRequest setAlsoMake(boolean alsoMake)
-am or --also-makealsoMake - enable 'also make' modeInvocationRequest setAlsoMakeDependents(boolean alsoMakeDependents)
-amd or --also-make-dependentsalsoMakeDependents - enable 'also make' modeInvocationRequest setResumeFrom(String resumeFrom)
-rf or --resume-fromresumeFrom - set the project to resume fromInvocationRequest setBuilder(String id)
--builder id. Note. This is available since Maven
 3.2.1id - The builder id.InvocationRequest FIXME: How to identify if this is a valid command line option?String getBuilder()
--builder id. Note. This is available since
 Maven 3.2.1int getTimeoutInSeconds()
void setTimeoutInSeconds(int timeoutInSeconds)
timeoutInSeconds - the timeout in seconds to execute the projectCopyright © 2002–2018 The Apache Software Foundation. All rights reserved.