Package org.apache.maven.shared.invoker

Interface InvocationRequest

  • All Known Implementing Classes:
    DefaultInvocationRequest
    public interface InvocationRequest
    Specifies the parameters used to control a Maven invocation.

    • Method Detail

      • isBatchMode

        boolean isBatchMode()
        By default, Maven is executed in batch mode. This mean no interaction with the Maven process can be done.
        Returns:
        true if Maven should be executed in batch mode, false if Maven is executed in interactive mode.
        Since:
        3.0.0

      • isOffline

        boolean isOffline()
        Gets the network mode of the Maven invocation. By default, Maven is executed in online mode.
        Returns:
        true if Maven should be executed in offline mode, false if the online mode is used.

      • isUpdateSnapshots

        boolean isUpdateSnapshots()
        Indicates whether Maven should enforce an update check for plugins and snapshots. By default, no update check is performed.
        Returns:
        true if plugins and snapshots should be updated, false otherwise.

      • isRecursive

        boolean isRecursive()
        Gets the recursion behavior of a reactor invocation. By default, Maven will recursive the build into sub modules.
        Returns:
        true if sub modules should be build, false otherwise.

      • getProjects

        List<String> getProjects()
        A list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path.
        Returns:
        the list of projects to add to reactor build, otherwise null
        Since:
        2.1

      • isAlsoMake

        boolean isAlsoMake()
        Get the value of the also-make argument.
        Returns:
        true if the argument also-make was specified, otherwise false
        Since:
        2.1

      • isAlsoMakeDependents

        boolean isAlsoMakeDependents()
        Get the value of the also-make-dependents
        Returns:
        true if the argument also-make-dependents was specified, otherwise false
        Since:
        2.1

      • getResumeFrom

        String getResumeFrom()
        Get the value of resume-from
        Returns:
        specified reactor project to resume from
        Since:
        2.1

      • isDebug

        boolean isDebug()
        Gets the debug mode of the Maven invocation. By default, Maven is executed in normal mode.
        Returns:
        true if Maven should be executed in debug mode, false if the normal mode should be used.

      • isShowErrors

        boolean isShowErrors()
        Gets the exception output mode of the Maven invocation. By default, Maven will not print stack traces of build exceptions.
        Returns:
        true if Maven should print stack traces, false otherwise.

      • isShellEnvironmentInherited

        boolean isShellEnvironmentInherited()
        Indicates whether the environment variables of the current process should be propagated to the Maven invocation. By default, the current environment variables are inherited by the new Maven invocation.
        Returns:
        true if the environment variables should be propagated, false otherwise.

      • isNonPluginUpdates

        boolean isNonPluginUpdates()
        Indicates whether Maven should check for plugin updates. By default, plugin updates are not suppressed.
        Returns:
        true if plugin updates should be suppressed, false otherwise.

      • getLocalRepositoryDirectory

        File getLocalRepositoryDirectory​(File defaultDirectory)
        Gets the path to the base directory of the local repository to use for the Maven invocation.
        Parameters:
        defaultDirectory - The default location to use if no location is configured for this request, may be null.
        Returns:
        The path to the base directory of the local repository or null to use the location from the settings.xml.

      • getInputStream

        InputStream getInputStream​(InputStream defaultStream)
        Gets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.
        Parameters:
        defaultStream - the default InputStream to use
        Returns:
        The input stream used to provide input for the invoked Maven build or null if not set.

      • getPomFile

        File getPomFile()
        Gets the path to the POM for the Maven invocation. If no base directory is set, the parent directory of this POM will be used as the working directory for the Maven invocation.
        Returns:
        The path to the POM for the Maven invocation or null if not set.

      • getPomFileName

        String getPomFileName()
        Gets the (unqualified) filename of the POM for the Maven invocation. This setting is ignored if 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.
        Returns:
        The (unqualified) filename of the POM for the Maven invocation or null if not set.

      • getBaseDirectory

        File getBaseDirectory()
        Gets the path to the base directory of the POM for the Maven invocation. If getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
        Returns:
        The path to the base directory of the POM or null if not set.

      • getBaseDirectory

        File getBaseDirectory​(File defaultDirectory)
        Gets the path to the base directory of the POM for the Maven invocation. If getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
        Parameters:
        defaultDirectory - The default base directory to use if none is configured for this request, may be null.
        Returns:
        The path to the base directory of the POM or null if not set.

      • getJavaHome

        File getJavaHome()
        Gets the path to the base directory of the Java installation used to run Maven.
        Returns:
        The path to the base directory of the Java installation used to run Maven or null to use the default Java home.

      • getProperties

        Properties getProperties()
        Gets the system properties for the Maven invocation.
        Returns:
        The system properties for the Maven invocation or null if not set.

      • getGoals

        List<String> getGoals()
        Gets the goals for the Maven invocation.
        Returns:
        The goals for the Maven invocation or null if not set.

      • getUserSettingsFile

        File getUserSettingsFile()
        Gets the path to the user settings for the Maven invocation.
        Returns:
        The path to the user settings for the Maven invocation or null to load the user settings from the default location.

      • getGlobalSettingsFile

        File getGlobalSettingsFile()
        Gets the path to the global settings for the Maven invocation.
        Returns:
        The path to the global settings for the Maven invocation or null to load the global settings from the default location.
        Since:
        2.1

      • getToolchainsFile

        File getToolchainsFile()
        Gets the path to the custom toolchains file
        Returns:
        The path to the custom toolchains file or null to load the toolchains from the default location
        Since:
        2.1

      • getGlobalToolchainsFile

        File getGlobalToolchainsFile()
        Alternate path for the global toolchains file Note. This is available since Maven 3.3.1
        Returns:
        The path to the custom global toolchains file or null to load the global toolchains from the default location.
        Since:
        3.0.0

      • getProfiles

        List<String> getProfiles()
        Gets the profiles for the Maven invocation.
        Returns:
        The profiles for the Maven invocation or null if not set.

      • getShellEnvironments

        Map<String,​String> getShellEnvironments()
        Gets the environment variables for the Maven invocation.
        Returns:
        The environment variables for the Maven invocation or null if not set.

      • getMavenOpts

        String getMavenOpts()
        Gets the value of the MAVEN_OPTS environment variable.
        Returns:
        The value of the MAVEN_OPTS environment variable or null if not set.

      • isShowVersion

        boolean isShowVersion()
        The show version behavior (-V option)
        Returns:
        The show version behavior
        Since:
        2.0.11

      • getThreads

        String getThreads()
        Get the value of the threads argument.
        Returns:
        the value of the threads argument or null if not set
        Since:
        2.1

      • isQuiet

        boolean isQuiet()
        Gets the quiet mode of the Maven invocation. By default, Maven is executed in normal mode.
        Returns:
        true if Maven should be executed in quiet mode, false if normal mode should be used.
        Since:
        3.1.0

      • setBatchMode

        InvocationRequest setBatchMode​(boolean batchMode)
        Sets the interaction mode of the Maven invocation. Equivalent of -B and --batch-mode
        Parameters:
        batchMode - true if Maven should be executed in non-interactive mode, false if the interactive modes is used.
        Returns:
        This invocation request.
        Since:
        3.0.0

      • setOffline

        InvocationRequest setOffline​(boolean offline)
        Sets the network mode of the Maven invocation. Equivalent of -o and --offline
        Parameters:
        offline - true if Maven should be executed in offline mode, false if the online mode is used.
        Returns:
        This invocation request.

      • setDebug

        InvocationRequest setDebug​(boolean debug)
        Sets the debug mode of the Maven invocation. Equivalent of -X and --debug
        Parameters:
        debug - true if Maven should be executed in debug mode, false if the normal mode should be used.
        Returns:
        This invocation request.

      • setShowErrors

        InvocationRequest setShowErrors​(boolean showErrors)
        Sets the exception output mode of the Maven invocation. Equivalent of -e and --errors
        Parameters:
        showErrors - true if Maven should print stack traces, false otherwise.
        Returns:
        This invocation request.

      • setUpdateSnapshots

        InvocationRequest setUpdateSnapshots​(boolean updateSnapshots)
        Specifies whether Maven should enforce an update check for plugins and snapshots. Equivalent of -U and --update-snapshots
        Parameters:
        updateSnapshots - true if plugins and snapshots should be updated, false otherwise.
        Returns:
        This invocation request.

      • setLocalRepositoryDirectory

        InvocationRequest setLocalRepositoryDirectory​(File localRepository)
        Sets the path to the base directory of the local repository to use for the Maven invocation.
        Parameters:
        localRepository - The path to the base directory of the local repository, may be null.
        Returns:
        This invocation request.

      • setInputStream

        InvocationRequest setInputStream​(InputStream inputStream)
        Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.
        Parameters:
        inputStream - The input stream used to provide input for the invoked Maven build, may be null if not required.
        Returns:
        This invocation request.

      • setOutputHandler

        InvocationRequest setOutputHandler​(InvocationOutputHandler outputHandler)
        Sets the handler used to capture the standard output from the Maven build.
        Parameters:
        outputHandler - The output handler, may be null if the output is not of interest.
        Returns:
        This invocation request.

      • setErrorHandler

        InvocationRequest setErrorHandler​(InvocationOutputHandler errorHandler)
        Sets the handler used to capture the error output from the Maven build.
        Parameters:
        errorHandler - The error handler, may be null if the output is not of interest.
        Returns:
        This invocation request.

      • setPomFile

        InvocationRequest setPomFile​(File pomFile)
        Sets the path to the POM for the Maven invocation. If no base directory is set, the parent directory of this POM will be used as the working directory for the Maven invocation.
        Parameters:
        pomFile - The path to the POM for the Maven invocation, may be null if not used.
        Returns:
        This invocation request.

      • setPomFileName

        InvocationRequest setPomFileName​(String pomFilename)
        Sets the (unqualified) filename of the POM for the Maven invocation. This setting is ignored if getPomFile() does not return null. Otherwise, the base directory is assumed to contain a POM with this name.
        Parameters:
        pomFilename - The (unqualified) filename of the POM for the Maven invocation, may be null if not used.
        Returns:
        This invocation request.

      • setBaseDirectory

        InvocationRequest setBaseDirectory​(File basedir)
        Sets the path to the base directory of the POM for the Maven invocation. If getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
        Parameters:
        basedir - The path to the base directory of the POM, may be null if not used.
        Returns:
        This invocation request.

      • setJavaHome

        InvocationRequest setJavaHome​(File javaHome)
        Sets the path to the base directory of the Java installation used to run Maven.
        Parameters:
        javaHome - The path to the base directory of the Java installation used to run Maven, may be null to use the default Java home.
        Returns:
        This invocation request.

      • setProperties

        InvocationRequest setProperties​(Properties properties)
        Sets the system properties for the Maven invocation.
        Parameters:
        properties - The system properties for the Maven invocation, may be null if not set.
        Returns:
        This invocation request.

      • setGoals

        InvocationRequest setGoals​(List<String> goals)
        Sets the goals for the Maven invocation.
        Parameters:
        goals - The goals for the Maven invocation, may be null to execute the POMs default goal.
        Returns:
        This invocation request.

      • setProfiles

        InvocationRequest setProfiles​(List<String> profiles)
        Sets the profiles for the Maven invocation. Equivalent of -P and --active-profiles
        Parameters:
        profiles - The profiles for the Maven invocation, may be null to use the default profiles.
        Returns:
        This invocation request.

      • setShellEnvironmentInherited

        InvocationRequest setShellEnvironmentInherited​(boolean shellEnvironmentInherited)
        Specifies whether the environment variables of the current process should be propagated to the Maven invocation.
        Parameters:
        shellEnvironmentInherited - true if the environment variables should be propagated, false otherwise.
        Returns:
        This invocation request.

      • setUserSettingsFile

        InvocationRequest setUserSettingsFile​(File userSettings)
        Sets the path to the user settings for the Maven invocation. Equivalent of -s and --settings
        Parameters:
        userSettings - The path to the user settings for the Maven invocation, may be null to load the user settings from the default location.
        Returns:
        This invocation request.

      • setGlobalSettingsFile

        InvocationRequest setGlobalSettingsFile​(File globalSettings)
        Sets the path to the global settings for the Maven invocation. Equivalent of -gs and --global-settings
        Parameters:
        globalSettings - The path to the global settings for the Maven invocation, may be null to load the global settings from the default location.
        Returns:
        This invocation request.
        Since:
        2.1

      • setToolchainsFile

        InvocationRequest setToolchainsFile​(File toolchains)
        Sets the alternate path for the user toolchains file Equivalent of -t or --toolchains
        Parameters:
        toolchains - the alternate path for the user toolchains file
        Returns:
        This invocation request
        Since:
        2.1

      • setGlobalToolchainsFile

        InvocationRequest setGlobalToolchainsFile​(File toolchains)
        Sets the alternate path for the global toolchains file Equivalent of -gt or --global-toolchains
        Parameters:
        toolchains - the alternate path for the global toolchains file
        Returns:
        This invocation request
        Since:
        3.0.0

      • setNonPluginUpdates

        InvocationRequest setNonPluginUpdates​(boolean nonPluginUpdates)
        Specifies whether Maven should check for plugin updates.

        Equivalent of -npu or --no-plugin-updates

        note: Ineffective with Maven3, only kept for backward compatibility

        Parameters:
        nonPluginUpdates - true if plugin updates should be suppressed, false otherwise.
        Returns:
        This invocation request.

      • setRecursive

        InvocationRequest setRecursive​(boolean recursive)
        Sets the recursion behavior of a reactor invocation. Inverse equivalent of -N and --non-recursive
        Parameters:
        recursive - true if sub modules should be build, false otherwise.
        Returns:
        This invocation request.

      • addShellEnvironment

        InvocationRequest addShellEnvironment​(String name,
                                      String value)
        Adds the specified environment variable to the Maven invocation.
        Parameters:
        name - The name of the environment variable, must not be null.
        value - The value of the environment variable, must not be null.
        Returns:
        This invocation request.

      • setMavenOpts

        InvocationRequest setMavenOpts​(String mavenOpts)
        Sets the value of the MAVEN_OPTS environment variable.
        Parameters:
        mavenOpts - The value of the MAVEN_OPTS environment variable, may be null to use the default options.
        Returns:
        This invocation request.

      • setShowVersion

        InvocationRequest setShowVersion​(boolean showVersion)
        enable displaying version without stopping the build Equivalent of -V or --show-version
        Parameters:
        showVersion - enable displaying version
        Returns:
        This invocation request.
        Since:
        2.0.11

      • setThreads

        InvocationRequest setThreads​(String threads)
        Thread count, for instance 2.0C where C is core multiplied Equivalent of -T or --threads

        note: available since Maven3

        Parameters:
        threads - the threadcount
        Returns:
        This invocation request.
        Since:
        2.1

      • setProjects

        InvocationRequest setProjects​(List<String> projects)
        Sets the reactor project list. Equivalent of -pl or --projects
        Parameters:
        projects - the reactor project list
        Returns:
        This invocation request.
        Since:
        2.1

      • setAlsoMake

        InvocationRequest setAlsoMake​(boolean alsoMake)
        Enable the 'also make' mode. Equivalent of -am or --also-make
        Parameters:
        alsoMake - enable 'also make' mode
        Returns:
        This invocation request.
        Since:
        2.1

      • setAlsoMakeDependents

        InvocationRequest setAlsoMakeDependents​(boolean alsoMakeDependents)
        Enable the 'also make dependents' mode. Equivalent of -amd or --also-make-dependents
        Parameters:
        alsoMakeDependents - enable 'also make' mode
        Returns:
        This invocation request.
        Since:
        2.1

      • setResumeFrom

        InvocationRequest setResumeFrom​(String resumeFrom)
        Resume reactor from specified project. Equivalent of -rf or --resume-from
        Parameters:
        resumeFrom - set the project to resume from
        Returns:
        This invocation request
        Since:
        2.1

      • setBuilder

        InvocationRequest setBuilder​(String id)
        The id of the build strategy to use. equivalent of --builder id. Note. This is available since Maven 3.2.1
        Parameters:
        id - The builder id.
        Returns:
        InvocationRequest FIXME: How to identify if this is a valid command line option?
        Since:
        3.0.0

      • setQuiet

        InvocationRequest setQuiet​(boolean quiet)
        Sets the quiet mode of the Maven invocation. Equivalent of -q and --quiet
        Parameters:
        quiet - true if Maven should be executed in quiet mode, false if the normal mode should be used.
        Returns:
        This invocation request.
        Since:
        3.1.0

      • getBuilder

        String getBuilder()
        Get the current set builder strategy id equivalent of --builder id. Note. This is available since Maven 3.2.1
        Returns:
        The current set builder id.
        Since:
        3.0.0

      • getTimeoutInSeconds

        int getTimeoutInSeconds()

        getTimeoutInSeconds.

        Returns:
        the timeout in seconds to execute the project
        Since:
        3.0.1

      • setTimeoutInSeconds

        void setTimeoutInSeconds​(int timeoutInSeconds)

        setTimeoutInSeconds.

        Parameters:
        timeoutInSeconds - the timeout in seconds to execute the project
        Since:
        3.0.1