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
hudson.FilePath	getDataDirectory() Returns the data directory.
org.owasp.dependencycheck.reporting.ReportGenerator.Format	getFormat() Returns the report format to be generated.
String	getName() Returns the name of the report to be displayed
hudson.FilePath	getOutputDirectory() Returns the destination directory for the generated report.
ArrayList<hudson.FilePath>	getScanPath() Returns the files and/or directory[s] to scan.
boolean	isAutoUpdate() Returns whether auto-updating of the NVD CVE/CPE data is enabled.
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	setDataDirectory(hudson.FilePath dataDirectory) Sets the data directory.
void	setFormat(org.owasp.dependencycheck.reporting.ReportGenerator.Format format) Sets the report format to be generated.
void	setName(String name) Sets the name of the report to be displayed
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.
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.

toString

public String toString()

Overrides:

toString in class Object