Package org.owasp.dependencycheck.analyzer

Class UnusedSuppressionRuleAnalyzer

java.lang.Object

org.owasp.dependencycheck.analyzer.AbstractAnalyzer

org.owasp.dependencycheck.analyzer.UnusedSuppressionRuleAnalyzer

All Implemented Interfaces:

Analyzer

public class UnusedSuppressionRuleAnalyzer
extends AbstractAnalyzer

Log the unused suppression rules.

Author:

Jeremy Long

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	EXCEPTION_MSG	Exception message.

Constructor Summary

Constructors

Constructor	Description
UnusedSuppressionRuleAnalyzer()

Method Summary

Modifier and Type	Method	Description
protected void	analyzeDependency(Dependency dependency, Engine engine)	Analyzes a given dependency.
protected void	checkUnusedRules(Engine engine)	check unused suppression RULES.
boolean	failsForUnusedSuppressionRule()
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.
int	getUnusedSuppressionRuleCount()
void	increaseUnusedSuppressionRuleCount()	increases the count of unused suppression rules.
void	initialize(Settings settings)	Initializes the analyzer with the configured settings.
boolean	supportsParallelProcessing()	The default is to support parallel processing.

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

analyze, close, closeAnalyzer, getSettings, isEnabled, prepare, prepareAnalyzer, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MSG

protected static final java.lang.String EXCEPTION_MSG

Exception message.

See Also:

Constant Field Values

Constructor Detail

UnusedSuppressionRuleAnalyzer

public UnusedSuppressionRuleAnalyzer()

Method Detail

initialize

public void initialize(Settings settings)

Description copied from class: AbstractAnalyzer

Initializes the analyzer with the configured settings.

Specified by:

initialize in interface Analyzer

Overrides:

initialize in class AbstractAnalyzer

Parameters:

settings - the configured settings to use

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.

Specified by:

analyzeDependency in class AbstractAnalyzer

Parameters:

dependency - the dependency to analyze

engine - the engine scanning

Throws:

AnalysisException - thrown if there is an analysis exception

checkUnusedRules

protected void checkUnusedRules(Engine engine)

check unused suppression RULES.

Parameters:

engine - a reference to the ODC engine

getAnalyzerEnabledSettingKey

protected java.lang.String getAnalyzerEnabledSettingKey()

Description copied from class: AbstractAnalyzer

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

getName

public java.lang.String getName()

Description copied from interface: Analyzer

Returns the name of the analyzer.

Returns:

the name of the analyzer.

getAnalysisPhase

public AnalysisPhase getAnalysisPhase()

Description copied from interface: Analyzer

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

Returns:

the phase that the analyzer is intended to run in.

supportsParallelProcessing

public boolean supportsParallelProcessing()

Description copied from class: AbstractAnalyzer

The default is to support parallel processing.

Specified by:

supportsParallelProcessing in interface Analyzer

Overrides:

supportsParallelProcessing in class AbstractAnalyzer

Returns:

true

increaseUnusedSuppressionRuleCount

public void increaseUnusedSuppressionRuleCount()

increases the count of unused suppression rules.

getUnusedSuppressionRuleCount

public int getUnusedSuppressionRuleCount()

Returns:

the count of unused suppression rules.

failsForUnusedSuppressionRule

public boolean failsForUnusedSuppressionRule()

Returns:

whether the analyzer will fail for a unused suppression rule.