com.google.cloud.tools.opensource.classpath.ClassPathBuilder Maven / Gradle / Ivy
Show all versions of dependencies Show documentation
/*
* Copyright 2019 Google LLC.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.tools.opensource.classpath;
import com.google.cloud.tools.opensource.dependencies.DependencyGraph;
import com.google.cloud.tools.opensource.dependencies.DependencyGraphBuilder;
import com.google.common.base.VerifyException;
import java.util.List;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.version.InvalidVersionSpecificationException;
/**
* Utility to build {@link ClassPathResult} that holds class path (a list of {@link ClassPathEntry})
* through a dependency tree of Maven artifacts.
*
* @see
* Setting the Class Path: Specification Order
* @see
* Maven: Introduction to the Dependency Mechanism
*/
public final class ClassPathBuilder {
private final DependencyGraphBuilder dependencyGraphBuilder;
public ClassPathBuilder() {
this(new DependencyGraphBuilder());
}
public ClassPathBuilder(DependencyGraphBuilder dependencyGraphBuilder) {
this.dependencyGraphBuilder = dependencyGraphBuilder;
}
/**
* Builds a classpath from the transitive dependency graph from {@code artifacts}. When there are
* multiple versions of an artifact in the dependency tree, the closest to the root in
* breadth-first order is picked up. This "pick closest" strategy follows Maven's dependency
* mediation.
*
* @param artifacts the first artifacts that appear in the classpath, in order
* @param full if true all optional dependencies and their transitive dependencies are included.
* If false, optional dependencies are not included.
* @param dependencyMediation the dependency mediation algorithm used when multiple versions of
* the same artifacts appears in the graph
*/
public ClassPathResult resolve(
List artifacts, boolean full, DependencyMediation dependencyMediation)
throws InvalidVersionSpecificationException {
// dependencyGraph holds multiple versions for one artifact key (groupId:artifactId)
DependencyGraph result;
if (full) {
result = dependencyGraphBuilder.buildFullDependencyGraph(artifacts);
} else {
result = dependencyGraphBuilder.buildVerboseDependencyGraph(artifacts);
}
return mediate(result, dependencyMediation);
}
/**
* Builds a class path from the dependency graph with {@code rootArtifact}, in the same way as
* Maven would do when the artifact was built.
*
* This method takes the root artifact of a dependency graph, while {@link #resolve(List,
* boolean, DependencyMediation)} takes a list of artifacts as the dependencies of a pseudo root
* artifact.
*/
ClassPathResult resolveWithMaven(Artifact rootArtifact) {
DependencyGraph result =
dependencyGraphBuilder.buildMavenDependencyGraph(new Dependency(rootArtifact, "compile"));
try {
return mediate(result, DependencyMediation.MAVEN);
} catch (InvalidVersionSpecificationException ex) {
// MavenDependencyMediation does not throw this exception
throw new VerifyException(
"Maven dependency mediation unexpectedly encountered an invalid version", ex);
}
}
private ClassPathResult mediate(DependencyGraph result, DependencyMediation dependencyMediation)
throws InvalidVersionSpecificationException {
AnnotatedClassPath classPathAnnotatedWithDependencyPath = dependencyMediation.mediate(result);
return new ClassPathResult(
classPathAnnotatedWithDependencyPath, result.getUnresolvedArtifacts());
}
}