DefaultInvoker (Apache Maven Invoker 3.2.0 API)

java.lang.Object
- org.apache.maven.shared.invoker.DefaultInvoker

All Implemented Interfaces:

Invoker
```
@Named
 @Singleton
public class DefaultInvoker
extends Object
implements Invoker
```
Class intended to be used by clients who wish to invoke a forked Maven process from their applications

Author:

jdcasey

Field Summary

Fields
Modifier and Type Field and Description

static String ROLE_HINT
Constant ROLE_HINT="default"
- Fields inherited from interface org.apache.maven.shared.invoker.Invoker
  ROLE

Fields
Modifier and Type	Field and Description
`static String`	`ROLE_HINT` Constant `ROLE_HINT="default"`

Constructor Summary

Constructors
Constructor and Description

DefaultInvoker()

Constructors
Constructor and Description
`DefaultInvoker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvocationResult`	`execute(InvocationRequest request)` Executes Maven using the parameters specified by the given invocation request.
`File`	`getLocalRepositoryDirectory()` Getter for the field `localRepositoryDirectory`.
`InvokerLogger`	`getLogger()` Getter for the field `logger`.
`File`	`getMavenExecutable()` Getter for the field `mavenExecutable`.
`File`	`getMavenHome()` Getter for the field `mavenHome`.
`File`	`getWorkingDirectory()` Getter for the field `workingDirectory`.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROLE_HINT
```
public static final String ROLE_HINT
```
    Constant ROLE_HINT="default"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultInvoker
```
public DefaultInvoker()
```
- Method Detail
  - execute
```
public 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.
    
    Specified by:
    
    execute in interface Invoker
    
    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
```
public File getLocalRepositoryDirectory()
```
    Getter for the field localRepositoryDirectory.
    
    Specified by:
    
    getLocalRepositoryDirectory in interface Invoker
    
    Returns:
    
    a File object.
  - getLogger
```
public InvokerLogger getLogger()
```
    Getter for the field logger.
    
    Specified by:
    
    getLogger in interface Invoker
    
    Returns:
    
    a InvokerLogger object.
  - setLocalRepositoryDirectory
```
public Invoker setLocalRepositoryDirectory(File localRepositoryDirectory)
```
    Sets the path to the base directory of the local repository to use for the Maven invocation.
    
    Specified by:
    
    setLocalRepositoryDirectory in interface Invoker
    
    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
```
public Invoker setLogger(InvokerLogger logger)
```
    Sets the logger used by this invoker to output diagnostic messages.
    
    Specified by:
    
    setLogger in interface Invoker
    
    Parameters:
    
    logger - The logger used by this invoker to output diagnostic messages, may be null to use a default logger.
    
    Returns:
    
    This invoker instance.
  - getWorkingDirectory
```
public File getWorkingDirectory()
```
    Getter for the field workingDirectory.
    
    Specified by:
    
    getWorkingDirectory in interface Invoker
    
    Returns:
    
    a File object.
  - setWorkingDirectory
```
public Invoker setWorkingDirectory(File workingDirectory)
```
    Sets the working directory for the Maven invocation.
    
    Specified by:
    
    setWorkingDirectory in interface Invoker
    
    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.
  - getMavenHome
```
public File getMavenHome()
```
    Getter for the field mavenHome.
    
    Specified by:
    
    getMavenHome in interface Invoker
    
    Returns:
    
    a File object.
  - setMavenHome
```
public 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.
    
    Specified by:
    
    setMavenHome in interface Invoker
    
    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
```
public File getMavenExecutable()
```
    Getter for the field mavenExecutable.
    
    Specified by:
    
    getMavenExecutable in interface Invoker
    
    Returns:
    
    a File object.
  - setMavenExecutable
```
public Invoker setMavenExecutable(File mavenExecutable)
```
    mavenExecutable can either be a file relative to ${maven.home}/bin/ or an absolute file.
    
    Specified by:
    
    setMavenExecutable in interface Invoker
    
    Parameters:
    
    mavenExecutable - the executable
    
    Returns:
    
    This invoker instance
  - setErrorHandler
```
public Invoker setErrorHandler(InvocationOutputHandler errorHandler)
```
    Sets the handler used to capture the error output from the Maven build.
    
    Specified by:
    
    setErrorHandler in interface Invoker
    
    Parameters:
    
    errorHandler - The error handler, may be null if the output is not of interest.
    
    Returns:
    
    This invoker instance.
  - setInputStream
```
public 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.
    
    Specified by:
    
    setInputStream in interface Invoker
    
    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
```
public Invoker setOutputHandler(InvocationOutputHandler outputHandler)
```
    Sets the handler used to capture the standard output from the Maven build.
    
    Specified by:
    
    setOutputHandler in interface Invoker
    
    Parameters:
    
    outputHandler - The output handler, may be null if the output is not of interest.
    
    Returns:
    
    This invoker instance.

Class DefaultInvoker

Field Summary

Fields inherited from interface org.apache.maven.shared.invoker.Invoker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROLE_HINT

Constructor Detail

DefaultInvoker

Method Detail

execute

getLocalRepositoryDirectory

getLogger

setLocalRepositoryDirectory

setLogger

getWorkingDirectory

setWorkingDirectory

getMavenHome

setMavenHome

getMavenExecutable

setMavenExecutable

setErrorHandler

setInputStream

setOutputHandler