com.simpligility.maven.provisioner.ArtifactRetriever Maven / Gradle / Ivy
/**
* Copyright simpligility technologies inc. http://www.simpligility.com
* Licensed under Eclipse Public License - v 1.0 http://www.eclipse.org/legal/epl-v10.html
*/
package com.simpligility.maven.provisioner;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.TreeSet;
import com.simpligility.maven.Gav;
import com.simpligility.maven.MavenConstants;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.collection.CollectRequest;
import org.eclipse.aether.collection.DependencySelector;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.DependencyFilter;
import org.eclipse.aether.repository.Authentication;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.ArtifactResolutionException;
import org.eclipse.aether.resolution.ArtifactResult;
import org.eclipse.aether.resolution.DependencyRequest;
import org.eclipse.aether.resolution.DependencyResolutionException;
import org.eclipse.aether.resolution.DependencyResult;
import org.eclipse.aether.util.artifact.JavaScopes;
import org.eclipse.aether.util.filter.DependencyFilterUtils;
import org.eclipse.aether.util.graph.selector.AndDependencySelector;
import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
import org.eclipse.aether.util.graph.selector.OptionalDependencySelector;
import org.eclipse.aether.util.graph.selector.ScopeDependencySelector;
import org.eclipse.aether.util.repository.AuthenticationBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* ArtifactRetriever can resolve a dependencies and all transitive dependencies and upstream parent pom's
* for a given GAV coordinate and fill a directory with the respective Maven repository containing those components.
*
* @author Manfred Moser - [email protected]
*/
public class ArtifactRetriever {
private static Logger logger = LoggerFactory.getLogger("ArtifactRetriever");
private RepositorySystem system;
private DefaultRepositorySystemSession session;
private File repositoryPath;
private RemoteRepository sourceRepository;
private final TreeSet successfulRetrievals = new TreeSet();
private final TreeSet failedRetrievals = new TreeSet();
public ArtifactRetriever(File repositoryPath) {
this.repositoryPath = repositoryPath;
initialize();
}
private void initialize() {
system = RepositoryHandler.getRepositorySystem();
session = RepositoryHandler.getRepositorySystemSession(system, repositoryPath);
}
public void retrieve(
List artifactCoordinates,
String sourceUrl,
String username,
String password,
boolean includeSources,
boolean includeJavadoc,
boolean includeProvidedScope,
boolean includeTestScope,
boolean includeRuntimeScope) {
RemoteRepository.Builder builder = new RemoteRepository.Builder("central", "default", sourceUrl);
builder.setProxy(ProxyHelper.getProxy(sourceUrl));
Authentication auth = new AuthenticationBuilder()
.addUsername(username)
.addPassword(password)
.build();
builder.setAuthentication(auth);
sourceRepository = builder.build();
getArtifactResults(artifactCoordinates, includeProvidedScope, includeTestScope, includeRuntimeScope);
getAdditionalArtifactsForRequest(artifactCoordinates);
getAdditionalArtifactsForArtifactsInCache(includeSources, includeJavadoc);
}
private List getArtifactResults(
List artifactCoordinates,
boolean includeProvidedScope,
boolean includeTestScope,
boolean includeRuntimeScope) {
List artifacts = new ArrayList();
for (String artifactCoordinate : artifactCoordinates) {
artifacts.add(new DefaultArtifact(artifactCoordinate));
}
List artifactResults = new ArrayList();
DependencyFilter depFilter = DependencyFilterUtils.classpathFilter(JavaScopes.TEST);
Collection includes = new ArrayList();
// we always include compile scope, not doing that makes no sense
includes.add(JavaScopes.COMPILE);
Collection excludes = new ArrayList();
// always exclude system scope since it is machine specific and wont work in 99% of cases
excludes.add(JavaScopes.SYSTEM);
if (includeProvidedScope) {
includes.add(JavaScopes.PROVIDED);
} else {
excludes.add(JavaScopes.PROVIDED);
}
if (includeTestScope) {
includes.add(JavaScopes.TEST);
} else {
excludes.add(JavaScopes.TEST);
}
if (includeRuntimeScope) {
includes.add(JavaScopes.RUNTIME);
}
DependencySelector selector = new AndDependencySelector(
new ScopeDependencySelector(includes, excludes),
new OptionalDependencySelector(),
new ExclusionDependencySelector());
session.setDependencySelector(selector);
for (Artifact artifact : artifacts) {
CollectRequest collectRequest = new CollectRequest();
collectRequest.setRoot(new Dependency(artifact, JavaScopes.COMPILE));
collectRequest.addRepository(sourceRepository);
DependencyRequest dependencyRequest = new DependencyRequest(collectRequest, depFilter);
try {
DependencyResult resolvedDependencies = system.resolveDependencies(session, dependencyRequest);
artifactResults.addAll(resolvedDependencies.getArtifactResults());
for (ArtifactResult result : resolvedDependencies.getArtifactResults()) {
successfulRetrievals.add(result.toString());
}
} catch (DependencyResolutionException e) {
String extension = artifact.getExtension();
if (MavenConstants.packagingUsesJarOnly(extension)) {
logger.info("Not reporting as failure due to " + artifact.getExtension() + " extension.");
} else {
logger.info("DependencyResolutionException ", e);
failedRetrievals.add(e.getMessage());
}
} catch (NullPointerException npe) {
logger.info("NullPointerException resolving dependencies for " + artifact + ":" + npe);
if (npe.getMessage() != null) {
failedRetrievals.add(npe.getMessage());
} else {
failedRetrievals.add("NPE retrieving " + artifact);
}
}
}
return artifactResults;
}
/**
* Iterate through the provided artifact coordinates to retrieve and pull additional artifact such as
* jar for bundle packaging, jar for aar packaging and so on as required. And get them even if not specified.
* @param artifactCoordinates
*/
private void getAdditionalArtifactsForRequest(List artifactCoordinates) {
List artifacts = new ArrayList();
for (String artifactCoordinate : artifactCoordinates) {
artifacts.add(new DefaultArtifact(artifactCoordinate));
}
for (Artifact artifact : artifacts) {
String extension = artifact.getExtension();
if (MavenConstants.packagingUsesJar(extension)) {
Gav gav = new Gav(
artifact.getGroupId(),
artifact.getArtifactId(),
artifact.getVersion(),
artifact.getExtension());
getJar(gav);
}
}
}
private void getAdditionalArtifactsForArtifactsInCache(boolean includeSources, boolean includeJavadoc) {
Collection pomFiles = MavenRepositoryDeployer.getPomFiles(repositoryPath);
for (File pomFile : pomFiles) {
logger.info("Processing POM file " + pomFile.getAbsolutePath());
Gav gav = null;
try {
gav = MavenRepositoryDeployer.getCoordinates(pomFile);
} catch (Exception e) {
logger.info("Failed to retrieve gav from " + pomFile.getAbsolutePath());
return;
}
String packaging = gav.getPackaging();
if (!MavenConstants.POM.equals(packaging)) {
// get additional jar for various packaging
if (MavenConstants.packagingUsesJar(packaging)) {
getJar(gav);
}
// get hpi or jpi or whatever even if parameter of request did not include packaging
// do not get for things such as plugin or bundle as there is none of that extension
if (MavenConstants.packagingUsesAdditionalJar(packaging)) {
getMainArtifact(gav);
}
if (includeSources) {
getSourcesJar(gav);
}
if (includeJavadoc) {
getJavadocJar(gav);
}
}
}
}
private void getMainArtifact(Gav gav) {
getArtifact(gav, null, null);
}
private void getJar(Gav gav) {
getArtifact(gav, MavenConstants.JAR, null);
}
private void getSourcesJar(Gav gav) {
getArtifact(gav, MavenConstants.JAR, MavenConstants.SOURCES);
}
private void getJavadocJar(Gav gav) {
getArtifact(gav, MavenConstants.JAR, MavenConstants.JAVADOC);
}
private void getArtifact(Gav gav, String packagingOverride, String classifier) {
String packaging;
if (StringUtils.isNotEmpty(packagingOverride)) {
packaging = packagingOverride;
} else {
packaging = gav.getPackaging();
}
Artifact artifact =
new DefaultArtifact(gav.getGroupId(), gav.getArtifactId(), classifier, packaging, gav.getVersion());
// avoid download if we got it locally already? or not bother and just get it again?
ArtifactRequest artifactRequest = new ArtifactRequest();
artifactRequest.setArtifact(artifact);
artifactRequest.addRepository(sourceRepository);
try {
ArtifactResult artifactResult = system.resolveArtifact(session, artifactRequest);
logger.info("Retrieved " + artifactResult.getArtifact().getFile());
successfulRetrievals.add(artifact.toString());
} catch (ArtifactResolutionException e) {
if (MavenConstants.BUNDLE.equals(packaging)) {
logger.info("Ignoring failure to retrieve " + gav + " with " + packaging + " and " + classifier);
}
logger.info("ArtifactResolutionException when retrieving " + gav + " with " + classifier);
failedRetrievals.add(e.getMessage());
}
}
public String listSucessfulRetrievals() {
StringBuilder builder = new StringBuilder();
builder.append("Sucessful Retrievals:\n\n");
for (String artifact : successfulRetrievals) {
builder.append(artifact + "\n");
}
return builder.toString();
}
public String listFailedTransfers() {
StringBuilder builder = new StringBuilder();
builder.append("Failed Retrievals:\n\n");
for (String artifact : failedRetrievals) {
builder.append(artifact + "\n");
}
return builder.toString();
}
public boolean hasFailures() {
return failedRetrievals.size() > 0;
}
public String getFailureMessage() {
return "Failed to retrieve some artifacts.";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy