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

Class ToolboxTool

java.lang.Object

org.apache.maven.cling.executor.internal.ToolboxTool

All Implemented Interfaces:

ExecutorTool

public class ToolboxTool
extends Object
implements ExecutorTool

ExecutorTool implementation based on Maveniverse Toolbox. It uses Toolbox mojos to implement all the required operations.

See Also:

• Maveniverse Toolbox

Constructor Summary

Constructors

Constructor	Description
ToolboxTool(ExecutorHelper helper)

Method Summary

Modifier and Type	Method	Description
String	artifactPath(ExecutorRequest.Builder executorRequest, String gav, String repositoryId)	Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given artifact in local repository.
Map<String,String>	dump(ExecutorRequest.Builder executorRequest)	Performs a diagnostic dump of the environment.
String	localRepository(ExecutorRequest.Builder executorRequest)	Returns the location of local repository, as detected by Maven.
String	metadataPath(ExecutorRequest.Builder executorRequest, 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

Constructor Details

ToolboxTool

public ToolboxTool(ExecutorHelper helper)

Method Details

dump

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

Description copied from interface: ExecutorTool

Performs a diagnostic dump of the environment.

Specified by:

dump in interface ExecutorTool

Parameters:

executorRequest - never null

Throws:

ExecutorException

localRepository

public String localRepository(ExecutorRequest.Builder executorRequest)
                       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:

executorRequest - never null

Throws:

ExecutorException

artifactPath

public String artifactPath(ExecutorRequest.Builder executorRequest,
 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:

executorRequest - 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 executorRequest,
 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:

executorRequest - never null

gav - the resolver metadata GAV string

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

Throws:

ExecutorException