Package org.apache.maven.shared.invoker
Class DefaultInvoker
- java.lang.Object
-
- org.apache.maven.shared.invoker.DefaultInvoker
-
- All Implemented Interfaces:
Invoker
@Component(role=Invoker.class, hint="default") public class DefaultInvoker extends java.lang.Object implements Invoker
Class intended to be used by clients who wish to invoke a forked Maven process from their applications
-
-
Field Summary
Fields Modifier and Type Field Description private static InvokerLogger
DEFAULT_LOGGER
private static InvocationOutputHandler
DEFAULT_OUTPUT_HANDLER
private InvocationOutputHandler
errorHandler
private java.io.InputStream
inputStream
private java.io.File
localRepositoryDirectory
private InvokerLogger
logger
private java.io.File
mavenExecutable
private java.io.File
mavenHome
private InvocationOutputHandler
outputHandler
static java.lang.String
ROLE_HINT
private java.io.File
workingDirectory
-
Constructor Summary
Constructors Constructor Description DefaultInvoker()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InvocationResult
execute(InvocationRequest request)
Executes Maven using the parameters specified by the given invocation request.private int
executeCommandLine(org.codehaus.plexus.util.cli.Commandline cli, InvocationRequest request)
java.io.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.java.io.File
getMavenExecutable()
Get the customized File of the Maven executable.java.io.File
getMavenHome()
Gets the path to the base directory of the Maven installation used to invoke Maven.java.io.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(java.io.InputStream inputStream)
Sets the input stream used to provide input for the invoked Maven build.Invoker
setLocalRepositoryDirectory(java.io.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(java.io.File mavenExecutable)
mavenExecutable
can either be a file relative to ${maven.home}/bin/ or an absolute file.Invoker
setMavenHome(java.io.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(java.io.File workingDirectory)
Sets the working directory for the Maven invocation.
-
-
-
Field Detail
-
ROLE_HINT
public static final java.lang.String ROLE_HINT
- See Also:
- Constant Field Values
-
DEFAULT_LOGGER
private static final InvokerLogger DEFAULT_LOGGER
-
DEFAULT_OUTPUT_HANDLER
private static final InvocationOutputHandler DEFAULT_OUTPUT_HANDLER
-
localRepositoryDirectory
private java.io.File localRepositoryDirectory
-
logger
private InvokerLogger logger
-
workingDirectory
private java.io.File workingDirectory
-
mavenHome
private java.io.File mavenHome
-
mavenExecutable
private java.io.File mavenExecutable
-
outputHandler
private InvocationOutputHandler outputHandler
-
inputStream
private java.io.InputStream inputStream
-
errorHandler
private InvocationOutputHandler errorHandler
-
-
Method Detail
-
execute
public InvocationResult execute(InvocationRequest request) throws MavenInvocationException
Description copied from interface:Invoker
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 interfaceInvoker
- Parameters:
request
- The invocation request to execute, must not benull
.- Returns:
- The result of the Maven invocation, never
null
. - Throws:
MavenInvocationException
-
executeCommandLine
private int executeCommandLine(org.codehaus.plexus.util.cli.Commandline cli, InvocationRequest request) throws org.codehaus.plexus.util.cli.CommandLineException
- Throws:
org.codehaus.plexus.util.cli.CommandLineException
-
getLocalRepositoryDirectory
public java.io.File getLocalRepositoryDirectory()
Description copied from interface:Invoker
Gets the path to the base directory of the local repository to use for the Maven invocation.- Specified by:
getLocalRepositoryDirectory
in interfaceInvoker
- Returns:
- The path to the base directory of the local repository or
null
to use the location from thesettings.xml
.
-
getLogger
public InvokerLogger getLogger()
Description copied from interface:Invoker
Gets the logger used by this invoker to output diagnostic messages.
-
setLocalRepositoryDirectory
public Invoker setLocalRepositoryDirectory(java.io.File localRepositoryDirectory)
Description copied from interface:Invoker
Sets the path to the base directory of the local repository to use for the Maven invocation.- Specified by:
setLocalRepositoryDirectory
in interfaceInvoker
- Parameters:
localRepositoryDirectory
- The path to the base directory of the local repository ornull
to use the location from thesettings.xml
.- Returns:
- This invoker instance.
-
setLogger
public Invoker setLogger(InvokerLogger logger)
Description copied from interface:Invoker
Sets the logger used by this invoker to output diagnostic messages.
-
getWorkingDirectory
public java.io.File getWorkingDirectory()
Description copied from interface:Invoker
Gets the working directory for the Maven invocation.- Specified by:
getWorkingDirectory
in interfaceInvoker
- Returns:
- The working directory for the Maven invocation or
null
if the working directory is derived from the base directory of the processed POM.
-
setWorkingDirectory
public Invoker setWorkingDirectory(java.io.File workingDirectory)
Description copied from interface:Invoker
Sets the working directory for the Maven invocation.- Specified by:
setWorkingDirectory
in interfaceInvoker
- Parameters:
workingDirectory
- The working directory for the Maven invocation, may benull
to derive the working directory from the base directory of the processed POM.- Returns:
- This invoker instance.
-
getMavenHome
public java.io.File getMavenHome()
Description copied from interface:Invoker
Gets the path to the base directory of the Maven installation used to invoke Maven.- Specified by:
getMavenHome
in interfaceInvoker
- Returns:
- The path to the base directory of the Maven installation or
null
if using the default Maven installation.
-
setMavenHome
public Invoker setMavenHome(java.io.File mavenHome)
Description copied from interface:Invoker
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 propertymaven.home
and the environment variableM2_HOME
.- Specified by:
setMavenHome
in interfaceInvoker
- Parameters:
mavenHome
- The path to the base directory of the Maven installation, may benull
to use the default Maven installation.- Returns:
- This invoker instance.
-
getMavenExecutable
public java.io.File getMavenExecutable()
Description copied from interface:Invoker
Get the customized File of the Maven executable.- Specified by:
getMavenExecutable
in interfaceInvoker
- Returns:
- the custom Maven executable, otherwise
null
-
setMavenExecutable
public Invoker setMavenExecutable(java.io.File mavenExecutable)
Description copied from interface:Invoker
mavenExecutable
can either be a file relative to ${maven.home}/bin/ or an absolute file.- Specified by:
setMavenExecutable
in interfaceInvoker
- Parameters:
mavenExecutable
- the executable- Returns:
- This invoker instance
-
setErrorHandler
public Invoker setErrorHandler(InvocationOutputHandler errorHandler)
Description copied from interface:Invoker
Sets the handler used to capture the error output from the Maven build.- Specified by:
setErrorHandler
in interfaceInvoker
- Parameters:
errorHandler
- The error handler, may benull
if the output is not of interest.- Returns:
- This invoker instance.
-
setInputStream
public Invoker setInputStream(java.io.InputStream inputStream)
Description copied from interface:Invoker
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 interfaceInvoker
- Parameters:
inputStream
- The input stream used to provide input for the invoked Maven build, may benull
if not required.- Returns:
- This invoker instance.
-
setOutputHandler
public Invoker setOutputHandler(InvocationOutputHandler outputHandler)
Description copied from interface:Invoker
Sets the handler used to capture the standard output from the Maven build.- Specified by:
setOutputHandler
in interfaceInvoker
- Parameters:
outputHandler
- The output handler, may benull
if the output is not of interest.- Returns:
- This invoker instance.
-
-