org.owasp.dependencycheck.maven

Class Engine

java.lang.Object

org.owasp.dependencycheck.Engine

org.owasp.dependencycheck.maven.Engine

public class Engine
extends Engine

A modified version of the core engine specifically designed to persist some data between multiple executions of a multi-module Maven project.

Author:

Jeremy Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_EXECUTED_FLAG Key used in the MavenProject context values to note whether or not an update has been executed.

Constructor Summary

Constructors

Constructor and Description
Engine(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects) Creates a new Engine to perform anyalsis on dependencies.

Method Summary

Methods

Modifier and Type	Method and Description
void	analyzeDependencies() Runs the analyzers against all of the dependencies.
void	cleanup() Releases resources used by the analyzers by calling close() on each analyzer.
protected void	closeAnalyzer(Analyzer analyzer) Closes the given analyzer.
protected Analyzer	initializeAnalyzer(Analyzer analyzer) Initializes the given analyzer.
void	resetFileTypeAnalyzers() Resets the file type analyzers so that they can be re-used to scan additional directories.
void	update() Runs the update steps of dependency-check.

Methods inherited from class org.owasp.dependencycheck.Engine

doUpdates, getAnalyzers, getAnalyzers, getDependencies, getFileTypeAnalyzers, initializeEngine, scan, scan, scan, scan, scan, scan, scanDirectory, scanFile, setDependencies, supportsExtension

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_EXECUTED_FLAG

public static final String UPDATE_EXECUTED_FLAG

Key used in the MavenProject context values to note whether or not an update has been executed.

See Also:

Constant Field Values

Constructor Detail

Engine

public Engine(org.apache.maven.project.MavenProject project,
      List<org.apache.maven.project.MavenProject> reactorProjects)
       throws DatabaseException

Creates a new Engine to perform anyalsis on dependencies.

Parameters:

project - the current Maven project

reactorProjects - the reactor projects for the current Maven execution

Throws:

DatabaseException - thrown if there is an issue connecting to the database

Method Detail

analyzeDependencies

public void analyzeDependencies()

Runs the analyzers against all of the dependencies.

Overrides:

analyzeDependencies in class Engine

update

public void update()

Runs the update steps of dependency-check.

initializeAnalyzer

protected Analyzer initializeAnalyzer(Analyzer analyzer)

Initializes the given analyzer. This skips the initialization of the CPEAnalyzer if it has been initialized by a previous execution.

Overrides:

initializeAnalyzer in class Engine

Parameters:

analyzer - the analyzer to initialize

Returns:

the initialized analyzer

cleanup

public void cleanup()

Releases resources used by the analyzers by calling close() on each analyzer.

Overrides:

cleanup in class Engine

closeAnalyzer

protected void closeAnalyzer(Analyzer analyzer)

Closes the given analyzer. This skips closing the CPEAnalyzer.

Overrides:

closeAnalyzer in class Engine

Parameters:

analyzer - the analyzer to close

resetFileTypeAnalyzers

public void resetFileTypeAnalyzers()

Resets the file type analyzers so that they can be re-used to scan additional directories. Without the reset the analyzer might be disabled because the first scan/analyze did not identify any files that could be processed by the analyzer.