/maven-utils

High level api to interact with maven from within the jvm

Primary LanguageJavaMIT LicenseMIT

maven-utils

maven-3.8.4-utils: Maven Central javadoc

maven-3.3.9-utils: Maven Central javadoc

High level api to interact with maven from within the jvm

Use it by adding the dependency to your maven pom:

<dependency>
    <groupId>se.alipsa</groupId>
    <artifactId>maven-3.8.4-utils</artifactId>
    <!-- or if you prefer the maven 3.3.9 version:
    <artifactId>maven-3.3.9-utils</artifactId>
    -->
    <version>1.0.2</version>

</dependency>

For SNAPSHOT builds you need to have snapshots enabled for the sonatype snapshots repo. Production releases are available in maven central so no repository configuration is needed.

<repository>
    <id>snapshots-repo</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    <releases><enabled>false</enabled></releases>
    <snapshots><enabled>true</enabled></snapshots>
</repository>

Basic usage

Running a maven goal

import org.apache.maven.shared.invoker.InvocationResult;
import se.alipsa.maven.MavenUtils;

File pomFile = new File("pom.xml");
InvocationResult result = MavenUtils.runMaven(pomFile, new String[]{"clean", "install"}, null, null);

The arguments to runMaven(final File pomFile, String[] mvnArgs, @Nullable InvocationOutputHandler consoleOutputHandler, @Nullable InvocationOutputHandler warningOutputHandler) are as follows:

  • pomFile the pom.xml file to parse
  • mvnArgs the arguments (targets) to send to maven (e.g. clean install)
  • consoleOutputHandler where normal maven output will be sent, defaults to System.out if null
  • warningOutputHandler where maven warning outputs will be sent, defaults to System.err if null
  • InvocationResult the result of running the targets
  • MavenInvocationException if there is a problem with parsing or running maven

Note that maven need to be installed locally for the maven invoker which is used to run maven to work. MavenUtils will first look for the MAVEN_HOME system property, then for the MAVEN_HOME environment variable and if still not found will try to locate the mvn command in the PATH.

The static method locateMavenHome is used to find maven home.

import se.alipsa.maven.MavenUtils;

String mavenHome = MavenUtils.locateMavenHome();

Get the local repository

import se.alipsa.maven.MavenUtils;
import org.eclipse.aether.repository.LocalRepository;

LocalRepository localRepository = MavenUtils.getLocalRepository();
For the methods below, an instance of MavenUtils must be created. This allows you to pass in a list of RemoteRepositories used for the resolution. If you use the default constructor (as in the examples below) you get the Maven Central and BeDatadriven repositories.

Parse a pom file into a Model

import java.io.File;
import org.apache.maven.model.Model;
import se.alipsa.maven.MavenUtils;

File pomFile = new File("pom.xml");
MavenUtils mavenUtils = new MavenUtils();
Model model = mavenUtils.parsePom(pomFile);

Get a Classloader with all dependencies resolved

import java.io.File;
import se.alipsa.maven.MavenUtils;

File pomFile = new File("pom.xml");
MavenUtils mavenUtils = new MavenUtils();
ClassLoader loader = mavenUtils.getMavenDependenciesClassloader(pomFile, this.getClass().getClassLoader())

The method is defined as getMavenDependenciesClassloader(File pomFile, @Nullable ClassLoader possibleParent)

Resolve a pom file and get a Set of files for the dependencies (and their transients)

import java.util.Set;
import java.io.File;
import se.alipsa.maven.MavenUtils;

File pomFile = new File("pom.xml");
MavenUtils mavenUtils = new MavenUtils();
Set<File> dependencies = mavenUtils.resolveDependencies(pomFile);

Fetch (resolve) a single artifact

import se.alipsa.maven.MavenUtils;
import java.io.File;

MavenUtils mavenUtils = new MavenUtils();
File file = mavenUtils.resolveArtifact("org.slf4j", "slf4j-api", null, "jar", "1.7.32");

The method is defined as resolveArtifact(String groupId, String artifactId, String classifier, String extension, String version)

  • groupId is the same as the tag in the pom.xml
  • artifactId is the same as the tag in the pom.xml
  • classifier is typically null, javadoc, sources, dist etc
  • extension could be pom, jar, zip etc.
  • version is the same as the tag in the pom.xml

For a more elaborate explanation see the maven documentation

Logging

Maven-utils uses slf4j for logging so a slf4j implementation needs to be present for logging to work.

License and dependencies

The code in this repository is licenced under the MIT license. However, maven-utils depends on a number of other libraries to be able to do its thing. Below is a list of them with their respective license.

org.slf4j:slf4j-api

Used for logging. Licence: MIT

org.apache.maven.shared:maven-invoker

Used to run maven. Licence: Apache 2.0

org.apache.maven.shared:maven-shared-utils

Used to run maven and to parse the pom file. Licence: Apache 2.0

org.apache.maven:maven-core

Used to run maven and to parse the pom file. Licence: Apache 2.0

org.eclipse.aether:aether-connector-basic

Used to resolve dependencies. License: EPL 1.0

org.eclipse.aether:aether-transport-file

Used to resolve dependencies. License: EPL 1.0

org.eclipse.aether:aether-transport-http

Used to resolve dependencies. License: EPL 1.0

org.junit.jupiter:junit-jupiter

User for unit testing. Licence: EPL 2.0

org.slf4j:slf4j-simple

User for unit testing. Licence: MIT

Version history

1.0.3

1.0.2, Mar 6, 2022

  • add dependency on later version of httpclient since the one that comes with aether-transport-http has security issues.
  • improve download artifact test
  • add dependency on later version commons-io since the one that comes with maven-shared-utils has security issues
  • Add support for system properties in (-Dkey=value) the maven arguments
  • upgrade slf4j dependency version

1.0.1, Jan 28, 2022

  • make locateMavenHome public.

1.0.0, Jan 27, 2022

  • Initial implementation, heavily based on similar functionality in the Ride project.