Invoker (Apache Maven Invoker 3.0.1 API)

All Known Implementing Classes:

DefaultInvoker
```
public interface Invoker
```
Provides a facade to invoke Maven.

Field Summary

Fields
Modifier and Type Field and Description

static String ROLE
The role name used to register implementations of this interface within Plexus.

Fields
Modifier and Type	Field and Description
`static String`	`ROLE` The role name used to register implementations of this interface within Plexus.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`InvocationResult`	`execute(InvocationRequest request)` Executes Maven using the parameters specified by the given invocation request.
`File`	`getLocalRepositoryDirectory()` Gets the path to the base directory of the local repository to use for the Maven invocation.
`InvokerLogger`	`getLogger()` Gets the logger used by this invoker to output diagnostic messages.
`File`	`getMavenExecutable()` Get the customized File of the Maven executable.
`File`	`getMavenHome()` Gets the path to the base directory of the Maven installation used to invoke Maven.
`File`	`getWorkingDirectory()` Gets the working directory for the Maven invocation.
`Invoker`	`setErrorHandler(InvocationOutputHandler errorHandler)` Sets the handler used to capture the error output from the Maven build.
`Invoker`	`setInputStream(InputStream inputStream)` Sets the input stream used to provide input for the invoked Maven build.
`Invoker`	`setLocalRepositoryDirectory(File localRepositoryDirectory)` Sets the path to the base directory of the local repository to use for the Maven invocation.
`Invoker`	`setLogger(InvokerLogger logger)` Sets the logger used by this invoker to output diagnostic messages.
`Invoker`	`setMavenExecutable(File mavenExecutable)` `mavenExecutable` can either be a file relative to ${maven.home}/bin/ or an absolute file.
`Invoker`	`setMavenHome(File mavenHome)` Sets the path to the base directory of the Maven installation used to invoke Maven.
`Invoker`	`setOutputHandler(InvocationOutputHandler outputHandler)` Sets the handler used to capture the standard output from the Maven build.
`Invoker`	`setWorkingDirectory(File workingDirectory)` Sets the working directory for the Maven invocation.

- Field Detail
  - ROLE
```
static final String ROLE
```
    The role name used to register implementations of this interface within Plexus.
- Method Detail
  - execute
```
InvocationResult execute(InvocationRequest request)
                  throws MavenInvocationException
```
    Executes Maven using the parameters specified by the given invocation request. Parameters not specified by the invocation request will be derived from the state of this invoker instance. In case both the invoker instance and the invocation request provide a value for a particular option, the value from the invocation request dominates.
    
    Parameters:
    
    request - The invocation request to execute, must not be null.
    
    Returns:
    
    The result of the Maven invocation, never null.
    
    Throws:
    
    MavenInvocationException - if cannot configure correctly execution parameters
  - getLocalRepositoryDirectory
```
File getLocalRepositoryDirectory()
```
    Gets the path to the base directory of the local repository to use for the Maven invocation.
    
    Returns:
    
    The path to the base directory of the local repository or null to use the location from the settings.xml.
  - getWorkingDirectory
```
File getWorkingDirectory()
```
    Gets the working directory for the Maven invocation.
    
    Returns:
    
    The working directory for the Maven invocation or null if the working directory is derived from the base directory of the processed POM.
  - getLogger
```
InvokerLogger getLogger()
```
    Gets the logger used by this invoker to output diagnostic messages.
    
    Returns:
    
    The logger used by this invoker to output diagnostic messages, never null.
  - getMavenHome
```
File getMavenHome()
```
    Gets the path to the base directory of the Maven installation used to invoke Maven.
    
    Returns:
    
    The path to the base directory of the Maven installation or null if using the default Maven installation.
  - setMavenHome
```
Invoker setMavenHome(File mavenHome)
```
    Sets the path to the base directory of the Maven installation used to invoke Maven. This parameter may be left unspecified to use the default Maven installation which will be discovered by evaluating the system property maven.home and the environment variable M2_HOME.
    
    Parameters:
    
    mavenHome - The path to the base directory of the Maven installation, may be null to use the default Maven installation.
    
    Returns:
    
    This invoker instance.
  - getMavenExecutable
```
File getMavenExecutable()
```
    Get the customized File of the Maven executable.
    
    Returns:
    
    the custom Maven executable, otherwise null
  - setMavenExecutable
```
Invoker setMavenExecutable(File mavenExecutable)
```
    mavenExecutable can either be a file relative to ${maven.home}/bin/ or an absolute file.
    
    Parameters:
    
    mavenExecutable - the executable
    
    Returns:
    
    This invoker instance
  - setLocalRepositoryDirectory
```
Invoker setLocalRepositoryDirectory(File localRepositoryDirectory)
```
    Sets the path to the base directory of the local repository to use for the Maven invocation.
    
    Parameters:
    
    localRepositoryDirectory - The path to the base directory of the local repository or null to use the location from the settings.xml.
    
    Returns:
    
    This invoker instance.
  - setLogger
```
Invoker setLogger(InvokerLogger logger)
```
    Sets the logger used by this invoker to output diagnostic messages.
    
    Parameters:
    
    logger - The logger used by this invoker to output diagnostic messages, may be null to use a default logger.
    
    Returns:
    
    This invoker instance.
  - setWorkingDirectory
```
Invoker setWorkingDirectory(File workingDirectory)
```
    Sets the working directory for the Maven invocation.
    
    Parameters:
    
    workingDirectory - The working directory for the Maven invocation, may be null to derive the working directory from the base directory of the processed POM.
    
    Returns:
    
    This invoker instance.
  - setInputStream
```
Invoker 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 invoker instance.
  - setOutputHandler
```
Invoker 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 invoker instance.
  - setErrorHandler
```
Invoker 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 invoker instance.

Interface Invoker

Field Summary

Method Summary

Field Detail

ROLE

Method Detail

execute

getLocalRepositoryDirectory

getWorkingDirectory

getLogger

getMavenHome

setMavenHome

getMavenExecutable

setMavenExecutable

setLocalRepositoryDirectory

setLogger

setWorkingDirectory

setInputStream

setOutputHandler

setErrorHandler