org.jenkinsci.plugins.DependencyCheck

Class Options

java.lang.Object

org.jenkinsci.plugins.DependencyCheck.Options

All Implemented Interfaces:

Serializable

public class Options
extends Object
implements Serializable

A container object that holds all of the configurable options to be used by a DependencyCheck analysis.

Author:

Steve Springett (steve.springett@owasp.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Methods

Modifier and Type	Method and Description
void	addScanPath(hudson.FilePath scanPath) Add a file and/or directory to scan
URL	getCveUrl12Base() Returns the CVE 1.2 base URL
URL	getCveUrl12Modified() Returns the CVE 1.2 modified URL
URL	getCveUrl20Base() Returns the CVE 2.0 base URL
URL	getCveUrl20Modified() Returns the CVE 2.0 modified URL
hudson.FilePath	getDataDirectory() Returns the data directory.
int	getDataMirroringType() Returns the data mirroring type (scheme) to use where 0 = none and 1 = NIST CPE/CVE
org.owasp.dependencycheck.reporting.ReportGenerator.Format	getFormat() Returns the report format to be generated.
hudson.FilePath	getMonoPath() Returns the full path and filename to the Mono binary
String	getName() Returns the name of the report to be displayed
URL	getNexusUrl() Returns the non-default Nexus URL to use
hudson.FilePath	getOutputDirectory() Returns the destination directory for the generated report.
ArrayList<hudson.FilePath>	getScanPath() Returns the files and/or directory[s] to scan.
hudson.FilePath	getSuppressionFile() Returns the suppression file
hudson.FilePath	getVerboseLoggingFile() Returns the verbose logging file
String	getZipExtensions() Returns the zip extensions
boolean	isAutoUpdate() Returns whether auto-updating of the NVD CVE/CPE data is enabled.
boolean	isNexusAnalyzerEnabled() Returns if the Nexus analyzer is enabled or not
boolean	isNexusProxyBypassed() Returns if the Nexus analyzer should bypass any proxy defined in Jenkins
boolean	isShowEvidence() Returns a boolean value (true/false) whether or not the evidence collected about a dependency is displayed in the report.
void	setAutoUpdate(boolean autoUpdate) Sets whether auto-updating of the NVD CVE/CPE data is enabled.
void	setCveUrl12Base(URL url) Sets the CVE 1.2 base URL
void	setCveUrl12Modified(URL url) Sets the CVE 1.2 modified URL
void	setCveUrl20Base(URL url) Sets the CVE 2.0 base URL
void	setCveUrl20Modified(URL url) Sets the CVE 2.0 modified URL
void	setDataDirectory(hudson.FilePath dataDirectory) Sets the data directory.
void	setDataMirroringType(int dataMirroringType) Sets the data mirroring type
void	setFormat(org.owasp.dependencycheck.reporting.ReportGenerator.Format format) Sets the report format to be generated.
void	setMonoPath(hudson.FilePath monoPath) Specifies the full path and filename to the mono binary
void	setName(String name) Sets the name of the report to be displayed
void	setNexusAnalyzerEnabled(boolean nexusAnalyzerEnabled) Sets if the Nexus analyzer is enabled or not
void	setNexusProxyBypassed(boolean nexusProxyBypass) Specifies if the Nexus analyzer should bypass any proxy defined in Jenkins
void	setNexusUrl(URL nexusUrl) Specifies the non-default Nexus URL to use
void	setOutputDirectory(hudson.FilePath outputDirectory) Sets the destination directory for the generated report.
void	setScanPath(ArrayList<hudson.FilePath> scanPath) Sets the file[s] and/or directory[s] to scan
void	setShowEvidence(boolean showEvidence) Sets a boolean value (true/false) whether or not the evidence collected about a dependency is displayed in the report.
void	setSuppressionFile(hudson.FilePath file) Sets the suppression file to use
void	setVerboseLoggingFile(hudson.FilePath file) Sets whether verbose logging of the Dependency-Check engine and analyzers is enabled.
void	setZipExtensions(String extensions) Sets the zip extensions - must be comma separated
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

getName

public String getName()

Returns the name of the report to be displayed

setName

public void setName(String name)

Sets the name of the report to be displayed

getScanPath

public ArrayList<hudson.FilePath> getScanPath()

Returns the files and/or directory[s] to scan.

setScanPath

public void setScanPath(ArrayList<hudson.FilePath> scanPath)

Sets the file[s] and/or directory[s] to scan

addScanPath

public void addScanPath(hudson.FilePath scanPath)

Add a file and/or directory to scan

getOutputDirectory

public hudson.FilePath getOutputDirectory()

Returns the destination directory for the generated report.

setOutputDirectory

public void setOutputDirectory(hudson.FilePath outputDirectory)

Sets the destination directory for the generated report.

getDataDirectory

public hudson.FilePath getDataDirectory()

Returns the data directory.

setDataDirectory

public void setDataDirectory(hudson.FilePath dataDirectory)

Sets the data directory.

isShowEvidence

public boolean isShowEvidence()

Returns a boolean value (true/false) whether or not the evidence collected about a dependency is displayed in the report. Default is false.

setShowEvidence

public void setShowEvidence(boolean showEvidence)

Sets a boolean value (true/false) whether or not the evidence collected about a dependency is displayed in the report.

getFormat

public org.owasp.dependencycheck.reporting.ReportGenerator.Format getFormat()

Returns the report format to be generated. Default is XML.

setFormat

public void setFormat(org.owasp.dependencycheck.reporting.ReportGenerator.Format format)

Sets the report format to be generated.

isAutoUpdate

public boolean isAutoUpdate()

Returns whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. Default is true.

setAutoUpdate

public void setAutoUpdate(boolean autoUpdate)

Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false.

getVerboseLoggingFile

public hudson.FilePath getVerboseLoggingFile()

Returns the verbose logging file

setVerboseLoggingFile

public void setVerboseLoggingFile(hudson.FilePath file)

Sets whether verbose logging of the Dependency-Check engine and analyzers is enabled.

getSuppressionFile

public hudson.FilePath getSuppressionFile()

Returns the suppression file

setSuppressionFile

public void setSuppressionFile(hudson.FilePath file)

Sets the suppression file to use

getZipExtensions

public String getZipExtensions()

Returns the zip extensions

setZipExtensions

public void setZipExtensions(String extensions)

Sets the zip extensions - must be comma separated

getDataMirroringType

public int getDataMirroringType()

Returns the data mirroring type (scheme) to use where 0 = none and 1 = NIST CPE/CVE

setDataMirroringType

public void setDataMirroringType(int dataMirroringType)

Sets the data mirroring type

getCveUrl12Modified

public URL getCveUrl12Modified()

Returns the CVE 1.2 modified URL

setCveUrl12Modified

public void setCveUrl12Modified(URL url)

Sets the CVE 1.2 modified URL

getCveUrl20Modified

public URL getCveUrl20Modified()

Returns the CVE 2.0 modified URL

setCveUrl20Modified

public void setCveUrl20Modified(URL url)

Sets the CVE 2.0 modified URL

getCveUrl12Base

public URL getCveUrl12Base()

Returns the CVE 1.2 base URL

setCveUrl12Base

public void setCveUrl12Base(URL url)

Sets the CVE 1.2 base URL

getCveUrl20Base

public URL getCveUrl20Base()

Returns the CVE 2.0 base URL

setCveUrl20Base

public void setCveUrl20Base(URL url)

Sets the CVE 2.0 base URL

isNexusAnalyzerEnabled

public boolean isNexusAnalyzerEnabled()

Returns if the Nexus analyzer is enabled or not

setNexusAnalyzerEnabled

public void setNexusAnalyzerEnabled(boolean nexusAnalyzerEnabled)

Sets if the Nexus analyzer is enabled or not

getNexusUrl

public URL getNexusUrl()

Returns the non-default Nexus URL to use

setNexusUrl

public void setNexusUrl(URL nexusUrl)

Specifies the non-default Nexus URL to use

isNexusProxyBypassed

public boolean isNexusProxyBypassed()

Returns if the Nexus analyzer should bypass any proxy defined in Jenkins

setNexusProxyBypassed

public void setNexusProxyBypassed(boolean nexusProxyBypass)

Specifies if the Nexus analyzer should bypass any proxy defined in Jenkins

getMonoPath

public hudson.FilePath getMonoPath()

Returns the full path and filename to the Mono binary

setMonoPath

public void setMonoPath(hudson.FilePath monoPath)

Specifies the full path and filename to the mono binary

toString

public String toString()

Overrides:

toString in class Object