Package org.apache.maven.cling.executor.internal

Class HelperImpl

java.lang.Object

org.apache.maven.cling.executor.internal.HelperImpl

All Implemented Interfaces:

ExecutorHelper, ExecutorTool

public class HelperImpl
extends Object
implements ExecutorHelper

Simple router to executors, and delegate to executor tool.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.cling.executor.ExecutorHelper

ExecutorHelper.Mode

Constructor Summary

Constructors

Constructor	Description
HelperImpl(ExecutorHelper.Mode defaultMode, Path installationDirectory, Executor embedded, Executor forked)

Method Summary

Modifier and Type	Method	Description
String	artifactPath(ExecutorRequest.Builder request, String gav, String repositoryId)	Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given artifact in local repository.
Map<String,String>	dump(ExecutorRequest.Builder request)	Performs a diagnostic dump of the environment.
int	execute(ExecutorHelper.Mode mode, ExecutorRequest executorRequest)	Executes the request with passed in mode executor.
ExecutorRequest.Builder	executorRequest()	Creates pre-populated builder for ExecutorRequest.
ExecutorHelper.Mode	getDefaultMode()	Returns the preferred mode of this helper.
protected Executor	getExecutor(ExecutorHelper.Mode mode, ExecutorRequest request)
String	localRepository(ExecutorRequest.Builder request)	Returns the location of local repository, as detected by Maven.
String	mavenVersion()	High level operation, returns the version of the Maven covered by this helper.
String	metadataPath(ExecutorRequest.Builder request, String gav, String repositoryId)	Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given metadata in local repository.

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.cling.executor.ExecutorHelper

execute

Constructor Details

HelperImpl

public HelperImpl(ExecutorHelper.Mode defaultMode,
 @Nullable
 Path installationDirectory,
 Executor embedded,
 Executor forked)

Method Details

getDefaultMode

public ExecutorHelper.Mode getDefaultMode()

Description copied from interface: ExecutorHelper

Returns the preferred mode of this helper.

Specified by:

getDefaultMode in interface ExecutorHelper

executorRequest

public ExecutorRequest.Builder executorRequest()

Description copied from interface: ExecutorHelper

Creates pre-populated builder for ExecutorRequest. Users of helper must use this method to create properly initialized request builder.

Specified by:

executorRequest in interface ExecutorHelper

execute

public int execute(ExecutorHelper.Mode mode,
 ExecutorRequest executorRequest)
            throws ExecutorException

Description copied from interface: ExecutorHelper

Executes the request with passed in mode executor.

Specified by:

execute in interface ExecutorHelper

Throws:

ExecutorException

mavenVersion

public String mavenVersion()

Description copied from interface: ExecutorHelper

High level operation, returns the version of the Maven covered by this helper. This method call caches underlying operation, and is safe to invoke as many times needed.

Specified by:

mavenVersion in interface ExecutorHelper

See Also:

• Executor.mavenVersion(ExecutorRequest)

dump

public Map<String,String> dump(ExecutorRequest.Builder request)
                        throws ExecutorException

Description copied from interface: ExecutorTool

Performs a diagnostic dump of the environment.

Specified by:

dump in interface ExecutorTool

Parameters:

request - never null

Throws:

ExecutorException

localRepository

public String localRepository(ExecutorRequest.Builder request)
                       throws ExecutorException

Description copied from interface: ExecutorTool

Returns the location of local repository, as detected by Maven. The userSettings param may contain some override (equivalent of -s settings.xml on CLI).

Specified by:

localRepository in interface ExecutorTool

Parameters:

request - never null

Throws:

ExecutorException

artifactPath

public String artifactPath(ExecutorRequest.Builder request,
 String gav,
 String repositoryId)
                    throws ExecutorException

Description copied from interface: ExecutorTool

Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given artifact in local repository.

Specified by:

artifactPath in interface ExecutorTool

Parameters:

request - never null

gav - the usual resolver artifact GAV string, never null

repositoryId - the remote repository ID in case "remote artifact" is asked for

Throws:

ExecutorException

metadataPath

public String metadataPath(ExecutorRequest.Builder request,
 String gav,
 String repositoryId)
                    throws ExecutorException

Description copied from interface: ExecutorTool

Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given metadata in local repository. The metadata coordinates in form of [G]:[A]:[V]:[type]. Absence of A implies absence of V as well (in other words, it can be G, G:A or G:A:V). The absence of type implies it is "maven-metadata.xml". The simplest spec string is :::.

Examples:

• ::: is root metadata named "maven-metadata.xml"
• :::my-metadata.xml is root metadata named "my-metadata.xml"
• G::: equals to G:::maven-metadata.xml
• G:A:: equals to G:A::maven-metadata.xml

Specified by:

metadataPath in interface ExecutorTool

Parameters:

request - never null

gav - the resolver metadata GAV string

repositoryId - the remote repository ID in case "remote metadata" is asked for

Throws:

ExecutorException

getExecutor

protected Executor getExecutor(ExecutorHelper.Mode mode,
 ExecutorRequest request)
                        throws ExecutorException

Throws:

ExecutorException