Class EmbeddedMavenExecutor

java.lang.Object

org.apache.maven.cling.executor.embedded.EmbeddedMavenExecutor

All Implemented Interfaces:

AutoCloseable, Executor

public class EmbeddedMavenExecutor
extends Object
implements Executor

Embedded executor implementation, that invokes Maven from installation directory within this same JVM but in isolated classloader. This class supports Maven 4.x and Maven 3.x as well. The ClassWorld of Maven is kept in memory as long as instance of this class is not closed. Subsequent execution requests over same installation home are cached.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	EmbeddedMavenExecutor.Context	Context holds things loaded up from given Maven Installation Directory.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	cacheContexts
protected final AtomicBoolean	closed
protected final ConcurrentHashMap<Path, EmbeddedMavenExecutor.Context>	contexts
protected static final Map<String,String>	MVN4_MAIN_CLASSES	Maven4 supports multiple commands from same installation directory.
protected final ClassLoader	originalClassLoader
protected final Properties	originalProperties
protected final PrintStream	originalStderr
protected final InputStream	originalStdin
protected final PrintStream	originalStdout
protected final boolean	useMavenArgsEnv

Fields inherited from interface org.apache.maven.api.cli.Executor

IS_WINDOWS, UNKNOWN_VERSION

Constructor Summary

Constructors

Constructor	Description
EmbeddedMavenExecutor()
EmbeddedMavenExecutor(boolean cacheContexts, boolean useMavenArgsEnv)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes and disposes of this Executor instance, releasing any resources it may hold.
protected URLClassLoader	createMavenBootClassLoader(Path boot, List<URL> extraClasspath)
protected void	disposeRuntimeCreatedRealms(EmbeddedMavenExecutor.Context context)	Unloads dynamically loaded things, like extensions created realms.
protected void	doClose(EmbeddedMavenExecutor.Context context)
protected EmbeddedMavenExecutor.Context	doCreate(Path mavenHome, ExecutorRequest executorRequest)
int	execute(ExecutorRequest executorRequest)	Invokes the tool application using the provided ExecutorRequest.
protected String	getMavenVersion(Class<?> clazz)
String	mavenVersion(ExecutorRequest executorRequest)	Returns the Maven version that provided ExecutorRequest point at (would use).
protected EmbeddedMavenExecutor.Context	mayCreate(ExecutorRequest executorRequest)
protected Properties	prepareProperties(ExecutorRequest request)
protected void	validate(ExecutorRequest executorRequest)

Methods inherited from class java.lang.Object

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

Field Details

MVN4_MAIN_CLASSES

protected static final Map<String,String> MVN4_MAIN_CLASSES

Maven4 supports multiple commands from same installation directory.

cacheContexts

protected final boolean cacheContexts

useMavenArgsEnv

protected final boolean useMavenArgsEnv

closed

protected final AtomicBoolean closed

originalStdin

protected final InputStream originalStdin

originalStdout

protected final PrintStream originalStdout

originalStderr

protected final PrintStream originalStderr

originalProperties

protected final Properties originalProperties

originalClassLoader

protected final ClassLoader originalClassLoader

contexts

protected final ConcurrentHashMap<Path, EmbeddedMavenExecutor.Context> contexts

Constructor Details

EmbeddedMavenExecutor

public EmbeddedMavenExecutor()

EmbeddedMavenExecutor

public EmbeddedMavenExecutor(boolean cacheContexts,
 boolean useMavenArgsEnv)

Method Details

execute

public int execute(ExecutorRequest executorRequest)
            throws ExecutorException

Description copied from interface: Executor

Invokes the tool application using the provided ExecutorRequest. This method is responsible for executing the command or build process based on the information contained in the request.

Specified by:

execute in interface Executor

Parameters:

executorRequest - the request containing all necessary information for the execution

Returns:

an integer representing the exit code of the execution (0 typically indicates success)

Throws:

ExecutorException - if an error occurs during the execution process

disposeRuntimeCreatedRealms

protected void disposeRuntimeCreatedRealms(EmbeddedMavenExecutor.Context context)

Unloads dynamically loaded things, like extensions created realms. Makes sure we go back to "initial state".

mavenVersion

public String mavenVersion(ExecutorRequest executorRequest)
                    throws ExecutorException

Description copied from interface: Executor

Returns the Maven version that provided ExecutorRequest point at (would use). This operation, depending on the underlying implementation, can be costly. If a caller uses this method often, it is the caller's responsibility to properly cache returned values. (key can be ExecutorRequest.installationDirectory().

Specified by:

mavenVersion in interface Executor

Parameters:

executorRequest - the request containing all necessary information for the execution

Returns:

a string representing the Maven version or Executor.UNKNOWN_VERSION

Throws:

ExecutorException - if an error occurs during the execution process

mayCreate

protected EmbeddedMavenExecutor.Context mayCreate(ExecutorRequest executorRequest)

doCreate

protected EmbeddedMavenExecutor.Context doCreate(Path mavenHome,
 ExecutorRequest executorRequest)

prepareProperties

protected Properties prepareProperties(ExecutorRequest request)

close

public void close()
           throws ExecutorException

Description copied from interface: Executor

Closes and disposes of this Executor instance, releasing any resources it may hold. This method is called automatically when using try-with-resources statements.

The default implementation does nothing. Subclasses should override this method if they need to perform cleanup operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Executor

Throws:

ExecutorException - if an error occurs while closing the Executor

doClose

protected void doClose(EmbeddedMavenExecutor.Context context)
                throws ExecutorException

Throws:

ExecutorException

validate

protected void validate(ExecutorRequest executorRequest)
                 throws ExecutorException

Throws:

ExecutorException

createMavenBootClassLoader

protected URLClassLoader createMavenBootClassLoader(Path boot,
 List<URL> extraClasspath)

getMavenVersion

protected String getMavenVersion(Class<?> clazz)
                          throws IOException

Throws:

IOException