com.csoft.utils.ArtifactUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of licensescan-maven-plugin Show documentation

Maven plugin for analysing the licenses in dependencies and transitive dependencies, asserting compatibility and potentially fail the build if forbidden licenses appear

The newest version!

package com.csoft.utils;

import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.project.MavenProject;

public class ArtifactUtils {

    private ArtifactUtils() {
    }

    /**
     * Extracts the set of Direct {@link Artifact} dependencies from a input {@link MavenProject}
     *
     * @param mavenProject The input project.
     * @return Set of dependencies.
     */
    public static Set getDirectDependencies(final MavenProject mavenProject) {
        //NOTE: MavenProject::getDependencyArtifacts automatically returns also diverse scopes such as 'test'.
        //We filter exclusively on 'runtime' and 'compile'.
        return mavenProject.getDependencyArtifacts().stream()
                .filter(artifact -> (artifact.getScope().equalsIgnoreCase("runtime") ||
                        artifact.getScope().equalsIgnoreCase("compile")))
                .collect(Collectors.toSet());
    }

    /**
     * Extracts the set of Transitive {@link Artifact} dependencies from a input
     * {@link MavenProject}.
     *
     * @param mavenProject The input project.
     * @return Set of dependencies.
     */
    public static Set getTransitiveDependencies(final MavenProject mavenProject) {
        //NOTE: we have to wrap MavenProject::getArtifacts and ::getDependencyArtifacts output sets into
        //an HashSet to make sure that we Set::removeAll behaves predictibly.
        Set transitiveDependencies = new HashSet<>(mavenProject.getArtifacts());
        transitiveDependencies.removeAll(new HashSet<>(getDirectDependencies(mavenProject)));
        return transitiveDependencies;
    }

    /**
     * Extracts the set of All {@link Artifact} dependencies (Direct + Transitive)
     * from a input {@link MavenProject}.
     *
     * @param mavenProject The input project.
     * @return Set of dependencies.
     */
    public static Set getCumulativeDependencies(final MavenProject mavenProject) {
        //NOTE: we have to wrap MavenProject::getArtifacts and ::getDependencyArtifacts output sets into
        //an HashSet to make sure that we Set::addAll behaves predictibly.
        Set cumulativeDependencies = new HashSet<>(mavenProject.getArtifacts());
        cumulativeDependencies.addAll(new HashSet<>(getDirectDependencies(mavenProject)));
        return cumulativeDependencies;
    }

}