org.apache.camel.maven.PrepareFatJarMojo Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.camel.maven;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import javax.inject.Inject;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ExcludesArtifactFilter;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
@Mojo(name = "prepare-fatjar", threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE,
defaultPhase = LifecyclePhase.PREPARE_PACKAGE)
public class PrepareFatJarMojo extends AbstractMojo {
private static final String GENERATED_MSG = "Generated by camel build tools - do NOT edit this file!";
private static final String NL = "\n";
private static final String META_INF_SERVICES_TYPE_CONVERTER_LOADER
= "META-INF/services/org/apache/camel/TypeConverterLoader";
private static final String META_INF_SERVICES_UBER_TYPE_CONVERTER_LOADER
= "META-INF/services/org/apache/camel/UberTypeConverterLoader";
private DynamicClassLoader projectClassLoader;
@Parameter(property = "project", required = true, readonly = true)
private MavenProject project;
@Parameter(defaultValue = "${project.build.outputDirectory}")
private File classesDirectory;
private final ArtifactFactory artifactFactory;
@Inject
public PrepareFatJarMojo(ArtifactFactory artifactFactory) {
this.artifactFactory = artifactFactory;
}
@Override
public void execute() throws MojoFailureException {
Collection loaders = findTypeConverterLoaderClasses();
if (loaders.isEmpty()) {
return;
}
getLog().info("Found " + loaders.size() + " Camel type converter loaders from project classpath");
// prepare output to generate
StringBuilder sb = new StringBuilder();
sb.append("# ");
sb.append(GENERATED_MSG);
sb.append(NL);
sb.append(String.join(NL, loaders));
sb.append(NL);
String data = sb.toString();
File file = new File(classesDirectory, META_INF_SERVICES_UBER_TYPE_CONVERTER_LOADER);
try {
writeFile(file, data);
} catch (IOException e) {
throw new MojoFailureException("Error updating " + file, e);
}
}
private void writeFile(File file, String data) throws IOException {
Path path = file.toPath();
Files.createDirectories(path.getParent());
Files.writeString(path, data, StandardOpenOption.WRITE, StandardOpenOption.CREATE,
StandardOpenOption.TRUNCATE_EXISTING);
}
/**
* Finds the type converter loader classes from the classpath looking for text files on the classpath at the
* {@link #META_INF_SERVICES_TYPE_CONVERTER_LOADER} location.
*/
protected Collection findTypeConverterLoaderClasses() {
Set loaders = new LinkedHashSet<>();
try {
Enumeration loaderResources = getProjectClassLoader().getResources(META_INF_SERVICES_TYPE_CONVERTER_LOADER);
while (loaderResources.hasMoreElements()) {
URL url = loaderResources.nextElement();
if (getLog().isDebugEnabled()) {
getLog().debug("Loading file " + META_INF_SERVICES_TYPE_CONVERTER_LOADER
+ " to retrieve list of type converters, from url: " + url);
}
readTypeConverters(loaders, url);
}
} catch (Exception e) {
getLog().warn("Error finding type converters due to " + e.getMessage());
}
return loaders;
}
private void readTypeConverters(Set loaders, URL url) throws IOException {
try (BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), StandardCharsets.UTF_8))) {
String line;
do {
line = reader.readLine();
if (line != null && !line.startsWith("#") && !line.isEmpty()) {
loaders.add(line);
}
} while (line != null);
}
}
protected final ClassLoader getProjectClassLoader() throws MojoExecutionException {
if (projectClassLoader == null) {
List urls = new ArrayList<>();
// need to include project compile dependencies (code similar to camel-maven-plugin)
addRelevantProjectDependenciesToClasspath(urls, false);
projectClassLoader = DynamicClassLoader.createDynamicClassLoaderFromUrls(urls);
}
return projectClassLoader;
}
/**
* Add any relevant project dependencies to the classpath. Takes includeProjectDependencies into consideration.
*
* @param path classpath of {@link URL} objects
*/
private void addRelevantProjectDependenciesToClasspath(List path, boolean testClasspathOnly)
throws MojoExecutionException {
try {
getLog().debug("Project Dependencies will be included.");
if (testClasspathOnly) {
URL testClasses = new File(project.getBuild().getTestOutputDirectory()).toURI().toURL();
if (getLog().isDebugEnabled()) {
getLog().debug("Adding to classpath : " + testClasses);
}
path.add(testClasses);
} else {
URL mainClasses = new File(project.getBuild().getOutputDirectory()).toURI().toURL();
if (getLog().isDebugEnabled()) {
getLog().debug("Adding to classpath : " + mainClasses);
}
path.add(mainClasses);
}
Set dependencies = project.getArtifacts();
// system scope dependencies are not returned by maven 2.0. See
// MEXEC-17
dependencies.addAll(getAllNonTestScopedDependencies());
for (Artifact classPathElement : dependencies) {
if (getLog().isDebugEnabled()) {
getLog().debug("Adding project dependency artifact: " + classPathElement.getArtifactId()
+ " to classpath");
}
File file = classPathElement.getFile();
if (file != null) {
path.add(file.toURI().toURL());
}
}
} catch (MalformedURLException e) {
throw new MojoExecutionException("Error during setting up classpath", e);
}
}
private Collection getAllNonTestScopedDependencies() throws MojoExecutionException {
List answer = new ArrayList<>();
for (Artifact artifact : getAllDependencies()) {
// do not add test artifacts
if (!artifact.getScope().equals(Artifact.SCOPE_TEST)) {
answer.add(artifact);
}
}
return answer;
}
// generic method to retrieve all the transitive dependencies
private Collection getAllDependencies() throws MojoExecutionException {
List artifacts = new ArrayList<>();
for (Dependency dependency : project.getDependencies()) {
String groupId = dependency.getGroupId();
String artifactId = dependency.getArtifactId();
VersionRange versionRange;
try {
versionRange = VersionRange.createFromVersionSpec(dependency.getVersion());
} catch (InvalidVersionSpecificationException e) {
throw new MojoExecutionException("unable to parse version", e);
}
String type = dependency.getType();
if (type == null) {
type = "jar";
}
String classifier = dependency.getClassifier();
boolean optional = dependency.isOptional();
String scope = dependency.getScope();
if (scope == null) {
scope = Artifact.SCOPE_COMPILE;
}
if (this.artifactFactory != null) {
Artifact art = this.artifactFactory.createDependencyArtifact(groupId, artifactId, versionRange,
type, classifier, scope, null, optional);
if (scope.equalsIgnoreCase(Artifact.SCOPE_SYSTEM)) {
art.setFile(new File(dependency.getSystemPath()));
}
List exclusions = new ArrayList<>();
for (Exclusion exclusion : dependency.getExclusions()) {
exclusions.add(exclusion.getGroupId() + ":" + exclusion.getArtifactId());
}
ArtifactFilter newFilter = new ExcludesArtifactFilter(exclusions);
art.setDependencyFilter(newFilter);
artifacts.add(art);
}
}
return artifacts;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy