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

Options()

Method Summary

void	addScanPath(hudson.FilePath scanPath) Add a file and/or directory to scan.
URL	getCentralUrl() Returns the non-default Maven Central URL to use.
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.
String	getProxyPassword() Returns the password to use to authenticate through the proxy server.
int	getProxyPort() Returns the port number to the proxy server.
String	getProxyServer() Returns the server (hostname/IP) of the proxy server.
String	getProxyUsername() Returns the username to use to authenticate through the proxy server.
ArrayList<hudson.FilePath>	getScanPath() Returns the files and/or directory[s] to scan.
Serializable	getSuppressionFile() Returns the suppression file.
hudson.FilePath	getSuppressionFilePath() Returns the suppression file.
URL	getSuppressionUrl() Returns the suppression file.
hudson.FilePath	getTempPath() Returns the full path of the temporary directory.
boolean	getUseMavenArtifactsScanPath() Returns if the scan path is solely populated by Maven artifacts.
hudson.FilePath	getVerboseLoggingFile() Returns the verbose logging file.
String	getWorkspace() Returns the path to the project workspace.
String	getZipExtensions() Returns the zip extensions.
boolean	isArchiveAnalyzerEnabled() Returns if the Archive analyzer is enabled or not.
boolean	isAssemblyAnalyzerEnabled() Returns if the Assembly analyzer is enabled or not.
boolean	isAutoUpdate() Returns whether auto-updating of the NVD CVE/CPE data is enabled.
boolean	isCentralAnalyzerEnabled() Returns if the Maven Central analyzer is enabled or not.
boolean	isJarAnalyzerEnabled() Returns if the Jar analyzer is enabled or not.
boolean	isJavascriptAnalyzerEnabled() Returns if the Javascript analyzer is enabled or not.
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	isNuspecAnalyzerEnabled() Returns if the NuSpec analyzer is enabled or not.
boolean	isPythonAnalyzerEnabled() Returns if the Python analyzer is enabled or not.
boolean	isShowEvidence() Returns a boolean value (true/false) whether or not the evidence collected about a dependency is displayed in the report.
boolean	isUpdateOnly() Returns whether updates should be the only task performed.
void	setArchiveAnalyzerEnabled(boolean archiveAnalyzerEnabled) Sets if the Archive analyzer is enabled or not.
void	setAssemblyAnalyzerEnabled(boolean assemblyAnalyzerEnabled) Sets if the Assembly analyzer is enabled or not.
void	setAutoUpdate(boolean autoUpdate) Sets whether auto-updating of the NVD CVE/CPE data is enabled.
void	setCentralAnalyzerEnabled(boolean centralAnalyzerEnabled) Sets if the Maven Central analyzer is enabled or not.
void	setCentralUrl(URL centralUrl) Specifies the non-default Maven Central URL to use.
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	setJarAnalyzerEnabled(boolean jarAnalyzerEnabled) Sets if the Jar analyzer is enabled or not.
void	setJavascriptAnalyzerEnabled(boolean javascriptAnalyzerEnabled) Sets if the Javascript analyzer is enabled or not.
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	setNuspecAnalyzerEnabled(boolean nuspecAnalyzerEnabled) Sets if the NuSpec analyzer is enabled or not.
void	setOutputDirectory(hudson.FilePath outputDirectory) Sets the destination directory for the generated report.
void	setProxyPassword(String proxyPassword) Sets the password to use to authenticate through the proxy server.
void	setProxyPort(int proxyPort) Sets the port number to the proxy server.
void	setProxyServer(String proxyServer) Sets the server (hostname/IP) of the proxy server.
void	setProxyUsername(String proxyUsername) Sets the username to use to authenticate through the proxy server.
void	setPythonAnalyzerEnabled(boolean pythonAnalyzerEnabled) Sets if the Python analyzer is enabled or not.
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(Serializable file) Sets the suppression file to use.
void	setTempPath(hudson.FilePath tempPath) Specifies the full path of the temporary directory.
void	setUpdateOnly(boolean updateOnly) Sets whether an NVD update should be the only thing performed.
void	setUseMavenArtifactsScanPath(boolean useMavenArtifactsScanPath) Sets if the scan path is solely populated by Maven artifacts.
void	setVerboseLoggingFile(hudson.FilePath file) Sets whether verbose logging of the Dependency-Check engine and analyzers is enabled.
void	setWorkspace(String workspace) Sets the path to the project workspace.
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

getWorkspace

public String getWorkspace()

Returns the path to the project workspace.

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.

setWorkspace

public void setWorkspace(String workspace)

Sets the path to the project workspace.

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.

isUpdateOnly

public boolean isUpdateOnly()

Returns whether updates should be the only task performed.

setUpdateOnly

public void setUpdateOnly(boolean updateOnly)

Sets whether an NVD update should be the only thing performed. If true, a scan will not be performed.

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 Serializable getSuppressionFile()

Returns the suppression file.

setSuppressionFile

public void setSuppressionFile(Serializable file)

Sets the suppression file to use.

getSuppressionUrl

public URL getSuppressionUrl()

Returns the suppression file.

getSuppressionFilePath

public hudson.FilePath getSuppressionFilePath()

Returns the suppression file.

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.

getProxyServer

public String getProxyServer()

Returns the server (hostname/IP) of the proxy server.

setProxyServer

public void setProxyServer(String proxyServer)

Sets the server (hostname/IP) of the proxy server.

getProxyPort

public int getProxyPort()

Returns the port number to the proxy server.

setProxyPort

public void setProxyPort(int proxyPort)

Sets the port number to the proxy server.

getProxyUsername

public String getProxyUsername()

Returns the username to use to authenticate through the proxy server.

setProxyUsername

public void setProxyUsername(String proxyUsername)

Sets the username to use to authenticate through the proxy server.

getProxyPassword

public String getProxyPassword()

Returns the password to use to authenticate through the proxy server.

setProxyPassword

public void setProxyPassword(String proxyPassword)

Sets the password to use to authenticate through the proxy server.

getUseMavenArtifactsScanPath

public boolean getUseMavenArtifactsScanPath()

Returns if the scan path is solely populated by Maven artifacts.

setUseMavenArtifactsScanPath

public void setUseMavenArtifactsScanPath(boolean useMavenArtifactsScanPath)

Sets if the scan path is solely populated by Maven artifacts.

isJarAnalyzerEnabled

public boolean isJarAnalyzerEnabled()

Returns if the Jar analyzer is enabled or not.

setJarAnalyzerEnabled

public void setJarAnalyzerEnabled(boolean jarAnalyzerEnabled)

Sets if the Jar analyzer is enabled or not.

isJavascriptAnalyzerEnabled

public boolean isJavascriptAnalyzerEnabled()

Returns if the Javascript analyzer is enabled or not.

setJavascriptAnalyzerEnabled

public void setJavascriptAnalyzerEnabled(boolean javascriptAnalyzerEnabled)

Sets if the Javascript analyzer is enabled or not.

isPythonAnalyzerEnabled

public boolean isPythonAnalyzerEnabled()

Returns if the Python analyzer is enabled or not.

setPythonAnalyzerEnabled

public void setPythonAnalyzerEnabled(boolean pythonAnalyzerEnabled)

Sets if the Python analyzer is enabled or not.

isArchiveAnalyzerEnabled

public boolean isArchiveAnalyzerEnabled()

Returns if the Archive analyzer is enabled or not.

setArchiveAnalyzerEnabled

public void setArchiveAnalyzerEnabled(boolean archiveAnalyzerEnabled)

Sets if the Archive analyzer is enabled or not.

isAssemblyAnalyzerEnabled

public boolean isAssemblyAnalyzerEnabled()

Returns if the Assembly analyzer is enabled or not.

setAssemblyAnalyzerEnabled

public void setAssemblyAnalyzerEnabled(boolean assemblyAnalyzerEnabled)

Sets if the Assembly analyzer is enabled or not.

isNuspecAnalyzerEnabled

public boolean isNuspecAnalyzerEnabled()

Returns if the NuSpec analyzer is enabled or not.

setNuspecAnalyzerEnabled

public void setNuspecAnalyzerEnabled(boolean nuspecAnalyzerEnabled)

Sets if the NuSpec analyzer is enabled or not.

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.

isCentralAnalyzerEnabled

public boolean isCentralAnalyzerEnabled()

Returns if the Maven Central analyzer is enabled or not.

setCentralAnalyzerEnabled

public void setCentralAnalyzerEnabled(boolean centralAnalyzerEnabled)

Sets if the Maven Central analyzer is enabled or not.

getCentralUrl

public URL getCentralUrl()

Returns the non-default Maven Central URL to use.

setCentralUrl

public void setCentralUrl(URL centralUrl)

Specifies the non-default Maven Central URL to use.

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.

getTempPath

public hudson.FilePath getTempPath()

Returns the full path of the temporary directory.

setTempPath

public void setTempPath(hudson.FilePath tempPath)

Specifies the full path of the temporary directory.

toString

public String toString()

Overrides:

toString in class Object