Class MavenInvoker

java.lang.Object

org.apache.maven.cling.invoker.LookupInvoker<MavenContext>

org.apache.maven.cling.invoker.mvn.MavenInvoker

All Implemented Interfaces:

AutoCloseable, Invoker

Direct Known Subclasses:

ResidentMavenInvoker

public class MavenInvoker
extends LookupInvoker<MavenContext>

The Maven invoker, that expects whole Maven on classpath and invokes it.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ANSI_RESET
protected static final Pattern	LAST_ANSI_SEQUENCE
protected static final Pattern	NEXT_LINE

Fields inherited from class org.apache.maven.cling.invoker.LookupInvoker

contextConsumer, protoLookup

Constructor Summary

Constructors

Constructor	Description
MavenInvoker(Lookup protoLookup, Consumer<LookupContext> contextConsumer)

Method Summary

Modifier and Type	Method	Description
protected MavenContext	createContext(InvokerRequest invokerRequest)
protected ExecutionListener	determineExecutionListener(MavenContext context)
protected String	determineGlobalChecksumPolicy(MavenContext context)
protected String	determineMakeBehavior(MavenContext context)
protected Path	determinePom(MavenContext context, Lookup lookup)
protected String	determineReactorFailureBehaviour(MavenContext context)
protected org.eclipse.aether.transfer.TransferListener	determineTransferListener(MavenContext context, boolean noTransferProgress)
protected int	doExecute(MavenContext context, MavenExecutionRequest request)
protected int	execute(MavenContext context)
protected String	getResumeFromSelector(List<MavenProject> mavenProjects, MavenProject firstFailedProject)	A helper method to determine the value to resume the build with -rf taking into account the edge case where multiple modules in the reactor have the same artifactId.
protected void	logBuildResumeHint(MavenContext context, String resumeBuildHint)
protected void	logSummary(MavenContext context, ExceptionSummary summary, Map<String,String> references, String indent)
protected void	lookup(MavenContext context)
protected void	performProfileActivation(MavenContext context, ProfileActivation profileActivation)
protected void	performProjectActivation(MavenContext context, ProjectActivation projectActivation)
protected void	populateRequest(MavenContext context, Lookup lookup, MavenExecutionRequest request)
protected void	postCommands(MavenContext context)
protected MavenExecutionRequest	prepareMavenExecutionRequest()
protected void	toolchains(MavenContext context, MavenExecutionRequest request)

Methods inherited from class org.apache.maven.cling.invoker.LookupInvoker

activateLogging, calculateDegreeOfConcurrency, configureLogging, container, createContainerCapsuleFactory, createCoreExtensionSelector, createTerminal, customizeSettingsRequest, customizeSettingsResult, describe, determineBuildEventListener, determineWriter, doConfigureWithTerminal, doConfigureWithTerminalWithRawStreamsDisabled, doConfigureWithTerminalWithRawStreamsEnabled, doCreateTerminal, doDetermineBuildEventListener, doDetermineWriter, doInvoke, handleException, helpOrVersionAndMayExit, init, invoke, localRepositoryPath, mayDisableInteractiveMode, populateRequestFromSettings, postContainer, preCommands, printErrors, pushCoreProperties, pushUserProperties, settings, settings, showVersion, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.api.cli.Invoker

close

Field Details

NEXT_LINE

protected static final Pattern NEXT_LINE

LAST_ANSI_SEQUENCE

protected static final Pattern LAST_ANSI_SEQUENCE

ANSI_RESET

protected static final String ANSI_RESET

See Also:

• Constant Field Values

Constructor Details

MavenInvoker

public MavenInvoker(Lookup protoLookup,
 @Nullable
 Consumer<LookupContext> contextConsumer)

Method Details

createContext

protected MavenContext createContext(InvokerRequest invokerRequest)

Specified by:

createContext in class LookupInvoker<MavenContext>

execute

protected int execute(MavenContext context)
               throws Exception

Specified by:

execute in class LookupInvoker<MavenContext>

Throws:

Exception

prepareMavenExecutionRequest

protected MavenExecutionRequest prepareMavenExecutionRequest()
                                                      throws Exception

Throws:

Exception

lookup

protected void lookup(MavenContext context)
               throws Exception

Overrides:

lookup in class LookupInvoker<MavenContext>

Throws:

Exception

postCommands

protected void postCommands(MavenContext context)
                     throws Exception

Overrides:

postCommands in class LookupInvoker<MavenContext>

Throws:

Exception

toolchains

protected void toolchains(MavenContext context,
 MavenExecutionRequest request)
                   throws Exception

Throws:

Exception

populateRequest

protected void populateRequest(MavenContext context,
 Lookup lookup,
 MavenExecutionRequest request)
                        throws Exception

Overrides:

populateRequest in class LookupInvoker<MavenContext>

Throws:

Exception

determinePom

protected Path determinePom(MavenContext context,
 Lookup lookup)

determineReactorFailureBehaviour

protected String determineReactorFailureBehaviour(MavenContext context)

determineGlobalChecksumPolicy

protected String determineGlobalChecksumPolicy(MavenContext context)

determineExecutionListener

protected ExecutionListener determineExecutionListener(MavenContext context)

determineTransferListener

protected org.eclipse.aether.transfer.TransferListener determineTransferListener(MavenContext context,
 boolean noTransferProgress)

determineMakeBehavior

protected String determineMakeBehavior(MavenContext context)

performProjectActivation

protected void performProjectActivation(MavenContext context,
 ProjectActivation projectActivation)

performProfileActivation

protected void performProfileActivation(MavenContext context,
 ProfileActivation profileActivation)

doExecute

protected int doExecute(MavenContext context,
 MavenExecutionRequest request)
                 throws Exception

Throws:

Exception

logBuildResumeHint

protected void logBuildResumeHint(MavenContext context,
 String resumeBuildHint)

getResumeFromSelector

protected String getResumeFromSelector(List<MavenProject> mavenProjects,
 MavenProject firstFailedProject)

A helper method to determine the value to resume the build with -rf taking into account the edge case where multiple modules in the reactor have the same artifactId.

-rf :artifactId will pick up the first module which matches, but when multiple modules in the reactor have the same artifactId, effective failed module might be later in build reactor. This means that developer will either have to type groupId or wait for build execution of all modules which were fine, but they are still before one which reported errors.

Then the returned value is groupId:artifactId when there is a name clash and :artifactId if there is no conflict. This method is made package-private for testing purposes.

Parameters:

mavenProjects - Maven projects which are part of build execution.

firstFailedProject - The first project which has failed.

Returns:

Value for -rf flag to resume build exactly from place where it failed (:artifactId in general and groupId:artifactId when there is a name clash).

logSummary

protected void logSummary(MavenContext context,
 ExceptionSummary summary,
 Map<String,String> references,
 String indent)