org.owasp.dependencycheck.analyzer

Class CpeSuppressionAnalyzer

java.lang.Object

org.owasp.dependencycheck.analyzer.AbstractAnalyzer

org.owasp.dependencycheck.analyzer.AbstractSuppressionAnalyzer

org.owasp.dependencycheck.analyzer.CpeSuppressionAnalyzer

All Implemented Interfaces:

Analyzer

@ThreadSafe
public class CpeSuppressionAnalyzer
extends AbstractSuppressionAnalyzer

This is no longer used as a standalone analyzer; rather this is called by the CPE Analyzer directly. TODO - refactor this class so that is not an 'analyzer'.

The suppression analyzer processes an externally defined XML document that complies with the suppressions.xsd schema. Any identified CPE entries within the dependencies that match will be removed.

Author:

Jeremy Long

Field Summary

Fields inherited from class org.owasp.dependencycheck.analyzer.AbstractSuppressionAnalyzer

SUPPRESSION_OBJECT_KEY

Constructor Summary

Constructors

Constructor and Description
CpeSuppressionAnalyzer()

Method Summary

Modifier and Type	Method and Description
protected void	analyzeDependency(Dependency dependency, Engine engine) Analyzes a given dependency.
boolean	filter(SuppressionRule rule) Determines whether a suppression rule should be retained when filtering a set of suppression rules for a concrete suppression analyzer.
AnalysisPhase	getAnalysisPhase() Returns the phase that the analyzer is intended to run in.
protected java.lang.String	getAnalyzerEnabledSettingKey() Returns the setting key to determine if the analyzer is enabled.
java.lang.String	getName() Returns the name of the analyzer.

Methods inherited from class org.owasp.dependencycheck.analyzer.AbstractSuppressionAnalyzer

getRuleCount, getSupportedExtensions, prepareAnalyzer

Methods inherited from class org.owasp.dependencycheck.analyzer.AbstractAnalyzer

analyze, close, closeAnalyzer, getSettings, initialize, isEnabled, prepare, setEnabled, supportsParallelProcessing

Methods inherited from class java.lang.Object

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

Constructor Detail

CpeSuppressionAnalyzer

public CpeSuppressionAnalyzer()

Method Detail

getName

public java.lang.String getName()

Returns the name of the analyzer.

Returns:

the name of the analyzer.

getAnalysisPhase

public AnalysisPhase getAnalysisPhase()

Returns the phase that the analyzer is intended to run in.

Returns:

the phase that the analyzer is intended to run in.

getAnalyzerEnabledSettingKey

protected java.lang.String getAnalyzerEnabledSettingKey()

Returns the setting key to determine if the analyzer is enabled.

Specified by:

getAnalyzerEnabledSettingKey in class AbstractAnalyzer

Returns:

the key for the analyzer's enabled property

filter

public boolean filter(SuppressionRule rule)

Description copied from class: AbstractSuppressionAnalyzer

Determines whether a suppression rule should be retained when filtering a set of suppression rules for a concrete suppression analyzer.

Parameters:

rule - the suppression rule to evaluate

Returns:

true if the rule should be retained; otherwise false

analyzeDependency

protected void analyzeDependency(Dependency dependency,
                                 Engine engine)
                          throws AnalysisException

Description copied from class: AbstractAnalyzer

Analyzes a given dependency. If the dependency is an archive, such as a WAR or EAR, the contents are extracted, scanned, and added to the list of dependencies within the engine.

Overrides:

analyzeDependency in class AbstractSuppressionAnalyzer

Parameters:

dependency - the dependency to analyze

engine - the engine scanning

Throws:

AnalysisException - thrown if there is an analysis exception