org.apache.karaf.tooling.utils

Class Dependency31Helper

java.lang.Object

org.apache.karaf.tooling.utils.Dependency31Helper

All Implemented Interfaces:

DependencyHelper

public class Dependency31Helper
extends Object
implements DependencyHelper

DependencyHelper for accessing Eclipse Aether system used in Maven 3.1+. It uses reflection to access these methods of maven-core APIs which directly references Eclipse Aether classes.

When karaf-maven-plugin switches to maven-core:3.1.0+, reflection should be use for Sonatype Aether in Dependency30Helper and this class will use Maven API directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dependency31Helper.ScopeDependencySelector2

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<LocalDependency>	localDependencies
protected String	treeListing

Constructor Summary

Constructors

Constructor and Description
Dependency31Helper(List<?> repositories, Object session, org.eclipse.aether.RepositorySystem repositorySystem)
Dependency31Helper(List<?> repositories, Object session, org.eclipse.aether.RepositorySystem repositorySystem, int cacheSize)

Method Summary

Modifier and Type	Method and Description
String	artifactToMvn(org.apache.maven.artifact.Artifact artifact, String versionOrRange) Convert a Maven Artifact into a PAX URL mvn format.
String	artifactToMvn(Object _artifact, String versionOrRange) Convert an Aether (Sonatype or Eclipse) artifact into a PAX URL mvn format.
String	getArtifactId(Object artifact)
String	getBaseVersion(Object artifact)
String	getClassifier(Object artifact)
void	getDependencies(org.apache.maven.project.MavenProject project, boolean useTransitiveDependencies)
String	getGroupId(Object artifact)
Set<LocalDependency>	getLocalDependencies()
String	getTreeListing()
boolean	isArtifactAFeature(Object artifact)
static boolean	isFeature(org.eclipse.aether.artifact.Artifact artifact)
static boolean	isFeature(org.eclipse.aether.graph.DependencyNode dependencyNode)
org.apache.maven.artifact.Artifact	mvnToArtifact(String name)
String	pathFromAether(String name) Convert an Aether coordinate format into a filesystem path.
String	pathFromMaven(String name) Convert a PAX URL mvn format into a filesystem path.
File	resolve(Object artifact, org.apache.maven.plugin.logging.Log log)
File	resolveById(String id, org.apache.maven.plugin.logging.Log log)
void	setRepositorySession(org.apache.maven.project.ProjectBuildingRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

localDependencies

protected Set<LocalDependency> localDependencies

treeListing

protected String treeListing

Constructor Detail

Dependency31Helper

public Dependency31Helper(List<?> repositories,
                          Object session,
                          org.eclipse.aether.RepositorySystem repositorySystem,
                          int cacheSize)

Dependency31Helper

public Dependency31Helper(List<?> repositories,
                          Object session,
                          org.eclipse.aether.RepositorySystem repositorySystem)

Method Detail

setRepositorySession

public void setRepositorySession(org.apache.maven.project.ProjectBuildingRequest request)
                          throws org.apache.maven.plugin.MojoExecutionException

Specified by:

setRepositorySession in interface DependencyHelper

Throws:

org.apache.maven.plugin.MojoExecutionException

getLocalDependencies

public Set<LocalDependency> getLocalDependencies()

Specified by:

getLocalDependencies in interface DependencyHelper

getTreeListing

public String getTreeListing()

Specified by:

getTreeListing in interface DependencyHelper

getDependencies

public void getDependencies(org.apache.maven.project.MavenProject project,
                            boolean useTransitiveDependencies)
                     throws org.apache.maven.plugin.MojoExecutionException

Specified by:

getDependencies in interface DependencyHelper

Throws:

org.apache.maven.plugin.MojoExecutionException

isFeature

public static boolean isFeature(org.eclipse.aether.graph.DependencyNode dependencyNode)

isFeature

public static boolean isFeature(org.eclipse.aether.artifact.Artifact artifact)

isArtifactAFeature

public boolean isArtifactAFeature(Object artifact)

Specified by:

isArtifactAFeature in interface DependencyHelper

getBaseVersion

public String getBaseVersion(Object artifact)

Specified by:

getBaseVersion in interface DependencyHelper

getGroupId

public String getGroupId(Object artifact)

Specified by:

getGroupId in interface DependencyHelper

getArtifactId

public String getArtifactId(Object artifact)

Specified by:

getArtifactId in interface DependencyHelper

getClassifier

public String getClassifier(Object artifact)

Specified by:

getClassifier in interface DependencyHelper

resolve

public File resolve(Object artifact,
                    org.apache.maven.plugin.logging.Log log)

Specified by:

resolve in interface DependencyHelper

resolveById

public File resolveById(String id,
                        org.apache.maven.plugin.logging.Log log)
                 throws org.apache.maven.plugin.MojoFailureException

Specified by:

resolveById in interface DependencyHelper

Throws:

org.apache.maven.plugin.MojoFailureException

artifactToMvn

public String artifactToMvn(org.apache.maven.artifact.Artifact artifact,
                            String versionOrRange)
                     throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: DependencyHelper

Convert a Maven Artifact into a PAX URL mvn format.

Specified by:

artifactToMvn in interface DependencyHelper

Parameters:

artifact - The Maven Artifact.

Returns:

The corresponding PAX URL mvn format (mvn:groupId/artifactId/version/type/classifier)

Throws:

org.apache.maven.plugin.MojoExecutionException - If the plugin execution fails.

artifactToMvn

public String artifactToMvn(Object _artifact,
                            String versionOrRange)

Description copied from interface: DependencyHelper

Convert an Aether (Sonatype or Eclipse) artifact into a PAX URL mvn format.

Specified by:

artifactToMvn in interface DependencyHelper

Parameters:

_artifact - The Aether org.sonatype|eclipse.aether.artifact.Artifact.

Returns:

The corresponding PAX URL mvn format (mvn:groupId/artifactId/version/type/classifier).

mvnToArtifact

public org.apache.maven.artifact.Artifact mvnToArtifact(String name)
                                                 throws org.apache.maven.plugin.MojoExecutionException

Specified by:

mvnToArtifact in interface DependencyHelper

Throws:

org.apache.maven.plugin.MojoExecutionException

pathFromMaven

public String pathFromMaven(String name)
                     throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: DependencyHelper

Convert a PAX URL mvn format into a filesystem path.

Specified by:

pathFromMaven in interface DependencyHelper

Parameters:

name - PAX URL mvn format (mvn:groupId/artifactId/version/type/classifier).

Returns:

The filesystem path.

Throws:

org.apache.maven.plugin.MojoExecutionException - If the plugin execution fails.

pathFromAether

public String pathFromAether(String name)
                      throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: DependencyHelper

Convert an Aether coordinate format into a filesystem path.

Specified by:

pathFromAether in interface DependencyHelper

Parameters:

name - The Aether coordinate format (groupId:artifactId[:extension[:classifier]]:version).

Returns:

The filesystem path.

Throws:

org.apache.maven.plugin.MojoExecutionException - If the plugin execution fails.