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=VERIFY,
      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 class BaseDependencyCheckMojo

PROTOCOL_HTTP, PROTOCOL_HTTPS

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	Description
CheckMojo()

Method Summary

Modifier and Type	Method	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.
protected ExceptionCollection	scanDependencies(Engine engine)	Scans the dependencies of the project.
protected ExceptionCollection	scanPlugins(Engine engine, ExceptionCollection exCollection)	Scans the plugins of the project.

Methods inherited from class BaseDependencyCheckMojo

checkForFailure, createProjectReferenceName, execute, generate, getArtifactScopeExcluded, getCategoryName, getConnectionString, getCorrectOutputDirectory, getCorrectOutputDirectory, getExcludes, getOutputDirectory, getOutputName, getProject, getReactorProjects, getReportOutputDirectory, getSettings, initializeEngine, isExternalReport, isFailOnError, isGeneratingSite, newResolveArtifactProjectBuildingRequest, populateSettings, resolveArtifactDependencies, runCheck, scanArtifacts, scanArtifacts, scanPlugins, setReportOutputDirectory, showSummary

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

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

getOutputPath

Constructor Details

CheckMojo

public CheckMojo()

Method Details

canGenerateReport

public boolean canGenerateReport()

Returns whether or not a the report can be generated.

Returns:

true if the report can be generated; otherwise false

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

scanDependencies

protected ExceptionCollection scanDependencies(Engine engine)
                                        throws org.apache.maven.plugin.MojoExecutionException

Scans the dependencies of the project.

Specified by:

scanDependencies in class BaseDependencyCheckMojo

Parameters:

engine - the engine used to perform the scanning

Returns:

a collection of exceptions

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if a fatal exception occurs

scanPlugins

protected ExceptionCollection scanPlugins(Engine engine,
 ExceptionCollection exCollection)
                                   throws org.apache.maven.plugin.MojoExecutionException

Scans the plugins of the project.

Specified by:

scanPlugins in class BaseDependencyCheckMojo

Parameters:

engine - the engine used to perform the scanning

exCollection - the collection of exceptions that might have occurred previously

Returns:

a collection of exceptions

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if a fatal exception occurs