Package org.owasp.dependencycheck.maven

Class PurgeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.owasp.dependencycheck.maven.BaseDependencyCheckMojo

org.owasp.dependencycheck.maven.PurgeMojo

All Implemented Interfaces:

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

@Mojo(name="purge",
      defaultPhase=GENERATE_RESOURCES,
      requiresProject=false,
      threadSafe=true,
      requiresDependencyResolution=NONE,
      requiresOnline=true,
      aggregator=true)
public class PurgeMojo
extends BaseDependencyCheckMojo

Maven Plugin that purges the local copy of the NVD data.

Author:

Jeremy Long

Field Summary

Fields inherited from class org.owasp.dependencycheck.maven.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
PurgeMojo()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()	Returns false; this mojo cannot generate a report.
java.lang.String	getDescription(java.util.Locale locale)	Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
java.lang.String	getName(java.util.Locale locale)	Returns the report name.
protected void	runCheck()	Purges the local copy of the NVD.
protected ExceptionCollection	scanDependencies(Engine engine)	Throws an exception if called.
protected ExceptionCollection	scanPlugins(Engine engine, ExceptionCollection exCollection)	Throws an exception if called.

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

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

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

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

getOutputPath

Constructor Detail

PurgeMojo

public PurgeMojo()

Method Detail

canGenerateReport

public boolean canGenerateReport()

Returns false; this mojo cannot generate a report.

Returns:

false

runCheck

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

Purges the local copy of the NVD.

Overrides:

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 java.lang.String getName(java.util.Locale locale)

Returns the report name.

Parameters:

locale - the location

Returns:

the report name

getDescription

public java.lang.String getDescription(java.util.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

Throws an exception if called. The purge mojo does not scan dependencies.

Specified by:

scanDependencies in class BaseDependencyCheckMojo

Parameters:

engine - the engine used to scan

Returns:

a collection of exceptions

Throws:

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

scanPlugins

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

Throws an exception if called. The purge mojo does not scan dependencies.

Specified by:

scanPlugins in class BaseDependencyCheckMojo

Parameters:

engine - the engine used to scan

exCollection - the collection of exceptions that might have occurred previously

Returns:

a collection of exceptions

Throws:

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