org.owasp.dependencycheck.maven

Class AggregateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.owasp.dependencycheck.maven.BaseDependencyCheckMojo

org.owasp.dependencycheck.maven.AggregateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

@Mojo(name="aggregate",
      defaultPhase=VERIFY,
      threadSafe=false,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      requiresOnline=true)
public class AggregateMojo
extends BaseDependencyCheckMojo

Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published vulnerabilities.

Author:

Jeremy Long

Field Summary

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AggregateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected Engine	generateDataFile() Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.
protected Engine	generateDataFile(Engine engine, org.apache.maven.project.MavenProject project) Runs dependency-check's Engine and writes the serialized dependencies to disk.
protected Set<org.apache.maven.project.MavenProject>	getDescendants(org.apache.maven.project.MavenProject project) Returns a set containing all the descendant projects of the given project.
String	getDescription(Locale locale) Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
String	getName(Locale locale) Returns the report name.
protected boolean	isMultiModule(org.apache.maven.project.MavenProject mavenProject) Test if the project has pom packaging
void	runCheck() Executes the aggregate dependency-check goal.

Methods inherited from class org.owasp.dependencycheck.maven.BaseDependencyCheckMojo

checkForFailure, excludeFromScan, execute, generate, generate, getCategoryName, getConnectionString, getCorrectOutputDirectory, getCorrectOutputDirectory, getDataFile, getDataFileContextKey, getFormat, getOutputDirectory, getOutputDirectoryContextKey, getOutputName, getProject, getReactorProjects, getReportOutputDirectory, initializeEngine, isExternalReport, populateSettings, readDataFile, scanArtifacts, setReportOutputDirectory, showSummary, writeDataFile, writeReports

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregateMojo

public AggregateMojo()

Method Detail

runCheck

public void runCheck()
              throws org.apache.maven.plugin.MojoExecutionException,
                     org.apache.maven.plugin.MojoFailureException

Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.

Specified by:

runCheck in class BaseDependencyCheckMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if there is ane exception running the mojo

org.apache.maven.plugin.MojoFailureException - thrown if dependency-check is configured to fail the build

getDescendants

protected Set<org.apache.maven.project.MavenProject> getDescendants(org.apache.maven.project.MavenProject project)

Returns a set containing all the descendant projects of the given project.

Parameters:

project - the project for which all descendants will be returned

Returns:

the set of descendant projects

isMultiModule

protected boolean isMultiModule(org.apache.maven.project.MavenProject mavenProject)

Test if the project has pom packaging

Parameters:

mavenProject - Project to test

Returns:

true if it has a pom packaging; otherwise false

generateDataFile

protected Engine generateDataFile()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException

Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.

Returns:

the Engine used to execute dependency-check

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if there is an exception running the mojo

org.apache.maven.plugin.MojoFailureException - thrown if dependency-check is configured to fail the build if severe CVEs are identified.

generateDataFile

protected Engine generateDataFile(Engine engine,
                      org.apache.maven.project.MavenProject project)
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException

Runs dependency-check's Engine and writes the serialized dependencies to disk.

Parameters:

engine - the Engine to use when scanning.

project - the project to scan and generate the data file for

Returns:

the Engine used to execute dependency-check

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if there is an exception running the mojo

org.apache.maven.plugin.MojoFailureException - thrown if dependency-check is configured to fail the build if severe CVEs are identified.

canGenerateReport

public boolean canGenerateReport()

getName

public String getName(Locale locale)

Returns the report name.

Parameters:

locale - the location

Returns:

the report name

getDescription

public String getDescription(Locale locale)

Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.

Parameters:

locale - The Locale to get the description for

Returns:

the description