Class ForkedMavenExecutor

java.lang.Object

org.apache.maven.cling.executor.forked.ForkedMavenExecutor

All Implemented Interfaces:

AutoCloseable, Executor

public class ForkedMavenExecutor
extends Object
implements Executor

Forked executor implementation, that spawns a subprocess with Maven from the installation directory. Very costly but provides the best isolation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicBoolean	closed
protected final boolean	useMavenArgsEnv

Fields inherited from interface Executor

IS_WINDOWS, UNKNOWN_VERSION

Constructor Summary

Constructors

Constructor	Description
ForkedMavenExecutor()
ForkedMavenExecutor(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 int	doExecute(ExecutorRequest executorRequest)
int	execute(ExecutorRequest executorRequest)	Invokes the tool application using the provided ExecutorRequest.
String	mavenVersion(ExecutorRequest executorRequest)	Returns the Maven version that provided ExecutorRequest point at (would use).
protected CountDownLatch	pump(Process p, ExecutorRequest executorRequest)
protected void	validate(ExecutorRequest executorRequest)

Methods inherited from class Object

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

Field Details

useMavenArgsEnv

protected final boolean useMavenArgsEnv

closed

protected final AtomicBoolean closed

Constructor Details

ForkedMavenExecutor

public ForkedMavenExecutor()

ForkedMavenExecutor

public ForkedMavenExecutor(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

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

validate

protected void validate(ExecutorRequest executorRequest)
                 throws ExecutorException

Throws:

ExecutorException

doExecute

protected int doExecute(ExecutorRequest executorRequest)
                 throws ExecutorException

Throws:

ExecutorException

pump

protected CountDownLatch pump(Process p,
 ExecutorRequest executorRequest)

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