Package org.apache.maven.cling.executor

Interface ExecutorTool

All Known Subinterfaces:

ExecutorHelper

All Known Implementing Classes:

HelperImpl, ToolboxTool

public interface ExecutorTool

A tool implementing some common Maven operations.

Method Summary

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

Method Details

dump

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

Performs a diagnostic dump of the environment.

Parameters:

request - never null

Throws:

ExecutorException

localRepository

String localRepository(ExecutorRequest.Builder request)
                throws ExecutorException

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

Parameters:

request - never null

Throws:

ExecutorException

artifactPath

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

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

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

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

Returns relative (to 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

Parameters:

request - never null

gav - the resolver metadata GAV string

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

Throws:

ExecutorException