org.owasp.dependencycheck.maven

Class CheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.owasp.dependencycheck.maven.BaseDependencyCheckMojo

org.owasp.dependencycheck.maven.CheckMojo

All Implemented Interfaces:

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

@Mojo(name="check",
      defaultPhase=COMPILE,
      threadSafe=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      requiresOnline=true)
public class CheckMojo
extends BaseDependencyCheckMojo

Maven Plugin that checks the project dependencies 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
CheckMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport() Returns whether or not a the report can be generated.
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.
void	runCheck() Executes the dependency-check engine on the project's dependencies and generates the report.

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

checkForFailure, excludeFromScan, execute, generate, generate, getCategoryName, getCorrectOutputDirectory, getCorrectOutputDirectory, getDataFile, getDataFileContextKey, getFormat, getOutputDirectory, getOutputDirectoryContextKey, getOutputName, getProject, getReactorProjects, getReportOutputDirectory, initializeEngine, isExternalReport, 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

CheckMojo

public CheckMojo()

Method Detail

canGenerateReport

public boolean canGenerateReport()

Returns whether or not a the report can be generated.

Returns:

true if the report can be generated; otherwise false

runCheck

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

Executes the dependency-check engine on the project's dependencies and generates the report.

Specified by:

runCheck in class BaseDependencyCheckMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if there is an exception executing the goal

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

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