com.gemnasium.AbstractMainMojo Maven / Gradle / Ivy

Go to download

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

The Gemnasium maven plugin helps you manage your projects dependencies with Gemnasium. Gemnasium keeps track of projects dependencies and send notifications when new versions are released or security advisories are published.

The newest version!

package com.gemnasium;

import com.gemnasium.utils.ProjectsUtils;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

/**
 * Main Mojo holding common stuff
 */
public abstract class AbstractMainMojo extends AbstractMojo {

    protected Config config;

    @Parameter(defaultValue = "${project}", readonly = true, required = true)
    protected MavenProject project;

    @Parameter(property = "basedir", defaultValue = "${basedir}", required = true)
    private File baseDir;

    @Parameter(property = "ignoredScopes")
    private String ignoredScopes;

    public void execute() throws MojoExecutionException {
        printHeader();
        loadConfig();
    }

    /**
     * Loads configuration
     * @throws MojoExecutionException if config can't be loaded
     */
    protected void loadConfig() throws MojoExecutionException {
        this.config = new Config(baseDir, ignoredScopes);
    }

    /**
    * Prints a header
    */
    protected void printHeader() {
        getLog().info("Gemnasium Maven Plugin");
        getLog().info("");
    }

    /**
    * Gets all project dependencies, direct and transitives,
    * but exclude those matching ignored scopes.
    * @return the project dependencies as List of Artifact
    */
    protected List getAllDependencies() {
        return ProjectsUtils.getFilteredDependencies(new ArrayList(project.getArtifacts()),
                config.getIgnoredScopes());
    }

    /**
    * Gets the project direct dependencies
    * @return the project dependencies as List of Dependency
    */
    protected List getDirectDependencies() {
        return new ArrayList(project.getDependencies());
    }
}