Class NugetconfAnalyzer

java.lang.Object

org.owasp.dependencycheck.analyzer.AbstractAnalyzer

org.owasp.dependencycheck.analyzer.AbstractFileTypeAnalyzer

org.owasp.dependencycheck.analyzer.NugetconfAnalyzer

All Implemented Interfaces:

FileFilter, Analyzer, FileTypeAnalyzer

@ThreadSafe
public class NugetconfAnalyzer
extends AbstractFileTypeAnalyzer

Analyzer which parses a Nuget packages.config file to gather module information.

Author:

doshyt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPENDENCY_ECOSYSTEM	A descriptor for the type of dependencies processed or added by this analyzer.
static final String	FILE_NAME	The file filter used to determine which files this analyzer supports.

Constructor Summary

Constructors

Constructor	Description
NugetconfAnalyzer()

Method Summary

Modifier and Type	Method	Description
void	analyzeDependency(Dependency dependency, Engine engine)	Performs the analysis.
AnalysisPhase	getAnalysisPhase()	Returns the analysis phase under which the analyzer runs.
protected String	getAnalyzerEnabledSettingKey()	Returns the key used in the properties file to reference the analyzer's enabled property.
protected FileFilter	getFileFilter()	Returns the FileFilter
String	getName()	Returns the analyzer's name.
void	prepareFileTypeAnalyzer(Engine engine)	Initializes the analyzer once before any analysis is performed.

Methods inherited from class AbstractFileTypeAnalyzer

accept, getFilesMatched, newHashSet, prepareAnalyzer, setFilesMatched

Methods inherited from class AbstractAnalyzer

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

Methods inherited from class Object

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

Methods inherited from interface Analyzer

analyze, close, initialize, isEnabled, prepare, supportsParallelProcessing

Field Details

DEPENDENCY_ECOSYSTEM

public static final String DEPENDENCY_ECOSYSTEM

A descriptor for the type of dependencies processed or added by this analyzer.

See Also:

• Constant Field Values

FILE_NAME

public static final String FILE_NAME

The file filter used to determine which files this analyzer supports.

See Also:

• Constant Field Values

Constructor Details

NugetconfAnalyzer

public NugetconfAnalyzer()

Method Details

prepareFileTypeAnalyzer

public void prepareFileTypeAnalyzer(Engine engine)
                             throws InitializationException

Initializes the analyzer once before any analysis is performed.

Specified by:

prepareFileTypeAnalyzer in class AbstractFileTypeAnalyzer

Parameters:

engine - a reference to the dependency-check engine

Throws:

InitializationException - if there's an error during initialization

getName

public String getName()

Returns the analyzer's name.

Returns:

the name of the analyzer

getAnalyzerEnabledSettingKey

protected String getAnalyzerEnabledSettingKey()

Returns the key used in the properties file to reference the analyzer's enabled property.

Specified by:

getAnalyzerEnabledSettingKey in class AbstractAnalyzer

Returns:

the analyzer's enabled property setting key

getAnalysisPhase

public AnalysisPhase getAnalysisPhase()

Returns the analysis phase under which the analyzer runs.

Returns:

the phase under which this analyzer runs

getFileFilter

protected FileFilter getFileFilter()

Returns the FileFilter

Specified by:

getFileFilter in class AbstractFileTypeAnalyzer

Returns:

the FileFilter

analyzeDependency

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

Performs the analysis.

Specified by:

analyzeDependency in class AbstractAnalyzer

Parameters:

dependency - the dependency to analyze

engine - the engine

Throws:

AnalysisException - when there's an exception during analysis