| 
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface InvocationRequest
Specifies the parameters used to control a Maven invocation.
| Field Summary | |
|---|---|
static String | 
CHECKSUM_POLICY_FAIL
The strict checksum policy which fails the build if a corrupt artifact is detected.  | 
static String | 
CHECKSUM_POLICY_WARN
The lax checksum policy which only outputs a warning if a corrupt artifact is detected.  | 
static String | 
REACTOR_FAIL_AT_END
The failure mode "fail-at-end" where the build is only failed at its very end if necessary.  | 
static String | 
REACTOR_FAIL_FAST
The failure mode "fail-fast" where the build is stopped by the first failure.  | 
static String | 
REACTOR_FAIL_NEVER
The failure mode "fail-never" in which Maven will always exit with code 0 regardless of build failures.  | 
| Method Summary | |
|---|---|
 InvocationRequest | 
activateReactor(String[] includes,
                String[] excludes)
Dynamically constructs a reactor using the subdirectories of the current directory  | 
 InvocationRequest | 
addShellEnvironment(String name,
                    String value)
Adds the specified environment variable to the Maven invocation.  | 
 String[] | 
getActivatedReactorExcludes()
Gets the list of subdirectory patterns to exclude from search  | 
 String[] | 
getActivatedReactorIncludes()
Gets the list of subdirectory patterns to search  | 
 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.  | 
 InvocationOutputHandler | 
getErrorHandler(InvocationOutputHandler defaultHandler)
Gets the handler used to capture the error output from the Maven build.  | 
 String | 
getFailureBehavior()
Gets the failure mode of the Maven invocation.  | 
 String | 
getGlobalChecksumPolicy()
Gets the checksum mode of the Maven invocation.  | 
 File | 
getGlobalSettingsFile()
Gets the path to the global settings for the Maven invocation.  | 
 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.  | 
 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. | 
 File | 
getToolchainsFile()
Gets the path to the custom toolchains file  | 
 File | 
getUserSettingsFile()
Gets the path to the user settings for the Maven invocation.  | 
 boolean | 
isActivatedReactor()
Gets whether Maven should search subdirectories to build a dynamic reactor  | 
 boolean | 
isAlsoMake()
Get the value of the also-make argument. | 
 boolean | 
isAlsoMakeDependents()
Get the value of the also-make-dependents | 
 boolean | 
isDebug()
Gets the debug mode of the Maven invocation.  | 
 boolean | 
isInteractive()
Gets the interaction 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 behaviour (-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 | 
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 | 
setFailureBehavior(String failureBehavior)
Sets the failure mode of the Maven invocation.  | 
 InvocationRequest | 
setGlobalChecksumPolicy(String 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 | 
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 | 
setInteractive(boolean interactive)
Sets the interaction mode of the Maven invocation.  | 
 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 | 
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
 
 note: available since Maven3
  | 
 InvocationRequest | 
setToolchainsFile(File toolchains)
Sets the alternate path for the user toolchains file Equivalent of -t or --toolchains
 
 note: available since Maven3
  | 
 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.  | 
| Field Detail | 
|---|
static final String REACTOR_FAIL_FAST
static final String REACTOR_FAIL_AT_END
static final String REACTOR_FAIL_NEVER
static final String CHECKSUM_POLICY_FAIL
static final String CHECKSUM_POLICY_WARN
| Method Detail | 
|---|
boolean isInteractive()
true if Maven should be executed in interactive mode, false if the batch
         mode is used.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.boolean isActivatedReactor()
true if we should search subdirectories, false otherwiseString[] getActivatedReactorIncludes()
null in which case defaults should be usedString[] getActivatedReactorExcludes()
null in which case nothing should be excludedList<String> getProjects()
nullboolean isAlsoMake()
also-make argument.
true if the argument also-make was specified, otherwise falseboolean isAlsoMakeDependents()
also-make-dependents
true if the argument also-make-dependents was specified, otherwise falseString getResumeFrom()
resume-from
boolean 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.String getFailureBehavior()
REACTOR_FAIL_FAST is used.
REACTOR_FAIL_FAST, REACTOR_FAIL_AT_END and
         REACTOR_FAIL_NEVER.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)
null if not set.InvocationOutputHandler getOutputHandler(InvocationOutputHandler defaultHandler)
null if not set.InvocationOutputHandler getErrorHandler(InvocationOutputHandler defaultHandler)
null 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 locationString getGlobalChecksumPolicy()
CHECKSUM_POLICY_WARN and CHECKSUM_POLICY_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 setInteractive(boolean interactive)
-B and --batch-mode
interactive - true if Maven should be executed in interactive mode, false if
            the batch mode is used.
InvocationRequest setOffline(boolean offline)
-o and --offline
offline - true if Maven should be executed in offline mode, false if the
            online mode is used.
InvocationRequest setDebug(boolean debug)
-X and --debug
debug - true if Maven should be executed in debug mode, false if the normal
            mode should be used.
InvocationRequest setShowErrors(boolean showErrors)
-e and --errors
showErrors - true if Maven should print stack traces, false otherwise.
InvocationRequest setUpdateSnapshots(boolean updateSnapshots)
-U and --update-snapshots
updateSnapshots - true if plugins and snapshots should be updated, false
            otherwise.
InvocationRequest setFailureBehavior(String failureBehavior)
-ff and --fail-fast, -fae and --fail-at-end, -fn and --fail-never
failureBehavior - The failure mode, must be one of REACTOR_FAIL_FAST, REACTOR_FAIL_AT_END
            and REACTOR_FAIL_NEVER.
InvocationRequest activateReactor(String[] includes,
                                  String[] excludes)
includes - a list of filename patterns to include, or null, in which case the default is */pom.xmlexcludes - a list of filename patterns to exclude, or null, in which case nothing is excluded
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-profiles
profiles - 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 --settings
userSettings - 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-settings
globalSettings - 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 --toolchains
 note: available since Maven3
toolchains - the alternate path for the user toolchains file
InvocationRequest setGlobalChecksumPolicy(String globalChecksumPolicy)
-c or --lax-checksums, -C or --strict-checksums
globalChecksumPolicy - The checksum mode, must be one of CHECKSUM_POLICY_WARN and
            CHECKSUM_POLICY_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-recursive
recursive - 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-version
showVersion - enable displaying version
InvocationRequest setThreads(String threads)
-T or --threads
 note: available since Maven3
threads - the threadcount
InvocationRequest setProjects(List<String> projects)
-P or --projects
projects - the reactor project list
InvocationRequest setAlsoMake(boolean alsoMake)
-am or --also-make
alsoMake - enable 'also make' mode
InvocationRequest setAlsoMakeDependents(boolean alsoMakeDependents)
-amd or --also-make-dependents
alsoMake - enable 'also make' mode
InvocationRequest setResumeFrom(String resumeFrom)
-rf or --resume-from
resumeFrom - set the project to resume from
  | 
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||