Check (Dependency-Check Ant Task 3.3.0 API)

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - org.owasp.dependencycheck.taskdefs.Purge
    - - org.owasp.dependencycheck.taskdefs.Update
      - org.owasp.dependencycheck.taskdefs.Check

All Implemented Interfaces:

Cloneable
```
@NotThreadSafe
public class Check
extends Update
```
An Ant task definition to execute dependency-check during an Ant build.

Author:

Jeremy Long

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Check.ReportFormats
An enumeration of supported report formats: "ALL", "HTML", "XML", "CSV", "JSON", "VULN", etc..

Nested Classes
Modifier and Type	Class and Description
`static class`	`Check.ReportFormats` An enumeration of supported report formats: "ALL", "HTML", "XML", "CSV", "JSON", "VULN", etc..

Field Summary
- Fields inherited from class org.apache.tools.ant.Task
  target, taskName, taskType, wrapper
- Fields inherited from class org.apache.tools.ant.ProjectComponent
  description, location, project

Constructor Summary

Constructors
Constructor and Description

Check()
Construct a new DependencyCheckTask.

Constructors
Constructor and Description
`Check()` Construct a new DependencyCheckTask.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(org.apache.tools.ant.types.ResourceCollection rc)` Add an arbitrary ResourceCollection.
`void`	`addConfiguredRetirejsFilter(RetirejsFilter retirejsFilter)` Add a regular expression to the set of retire JS content filters.
`void`	`addConfiguredSuppressionFile(SuppressionFile suppressionFile)` Add a suppression file.
`void`	`execute()` Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the local database.
`String`	`getApplicationName()` Deprecated. use projectName instead.
`String`	`getArtifactoryAnalyzerApiToken()` Returns the value of artifactoryAnalyzerApiToken.
`String`	`getArtifactoryAnalyzerBearerToken()` Returns the value of artifactoryAnalyzerBearerToken.
`Boolean`	`getArtifactoryAnalyzerEnabled()` Returns the value of artifactoryAnalyzerEnabled.
`Boolean`	`getArtifactoryAnalyzerParallelAnalysis()` Returns the value of artifactoryAnalyzerParallelAnalysis.
`String`	`getArtifactoryAnalyzerUrl()` Returns the value of artifactoryAnalyzerUrl.
`Boolean`	`getArtifactoryAnalyzerUseProxy()` Returns the value of artifactoryAnalyzerUseProxy.
`String`	`getArtifactoryAnalyzerUsername()` Returns the value of artifactoryAnalyzerUsername.
`String`	`getBundleAuditPath()` Returns the path to the bundle audit executable.
`Boolean`	`getCmakeAnalyzerEnabled()` Returns the value of cmakeAnalyzerEnabled.
`float`	`getFailBuildOnCVSS()` Get the value of failBuildOnCVSS.
`String`	`getHintsFile()` Get the value of hintsFile.
`String`	`getNexusUrl()` Get the value of nexusUrl.
`String`	`getPathToMono()` Get the value of pathToMono.
`String`	`getProjectName()` Get the value of projectName.
`String`	`getReportFormat()` Get the value of reportFormat.
`String`	`getReportOutputDirectory()` Get the value of reportOutputDirectory.
`List<String>`	`getRetirejsFilters()` Gets retire JS Analyzers file content filters.
`List<String>`	`getSuppressionFiles()` Gets suppression file paths.
`String`	`getZipExtensions()` Get the value of zipExtensions.
`Boolean`	`isArchiveAnalyzerEnabled()` Returns whether or not the analyzer is enabled.
`Boolean`	`isAssemblyAnalyzerEnabled()` Returns whether or not the analyzer is enabled.
`Boolean`	`isAutoconfAnalyzerEnabled()` Get the value of autoconfAnalyzerEnabled.
`Boolean`	`isAutoUpdate()` Get the value of autoUpdate.
`Boolean`	`isBundleAuditAnalyzerEnabled()` Returns if the Bundle Audit Analyzer is enabled.
`Boolean`	`isCentralAnalyzerEnabled()` Get the value of centralAnalyzerEnabled.
`Boolean`	`isCMakeAnalyzerEnabled()` Get the value of cmakeAnalyzerEnabled.
`boolean`	`isCocoapodsAnalyzerEnabled()` Returns if the cocoapods analyzer is enabled.
`Boolean`	`isComposerAnalyzerEnabled()` Get the value of composerAnalyzerEnabled.
`Boolean`	`isEnableExperimental()` Get the value of enableExperimental.
`Boolean`	`isEnableRetired()` Get the value of enableRetired.
`Boolean`	`isJarAnalyzerEnabled()` Returns whether or not the analyzer is enabled.
`Boolean`	`isNexusAnalyzerEnabled()` Get the value of nexusAnalyzerEnabled.
`Boolean`	`isNexusUsesProxy()` Get the value of nexusUsesProxy.
`Boolean`	`isNodeAnalyzerEnabled()` Get the value of nodeAnalyzerEnabled.
`Boolean`	`isNspAnalyzerEnabled()` Get the value of nspAnalyzerEnabled.
`Boolean`	`isNuspecAnalyzerEnabled()` Returns whether or not the analyzer is enabled.
`Boolean`	`isOpensslAnalyzerEnabled()` Get the value of opensslAnalyzerEnabled.
`Boolean`	`isPyDistributionAnalyzerEnabled()` Get the value of pyDistributionAnalyzerEnabled.
`Boolean`	`isPyPackageAnalyzerEnabled()` Get the value of pyPackageAnalyzerEnabled.
`boolean`	`isReference()` Learn whether the refId attribute of this element been set.
`Boolean`	`isRetireJsAnalyzerEnabled()` Get the value of retireJsAnalyzerEnabled.
`Boolean`	`isRetirejsFilterNonVulnerable()` Get the value of retirejsFilterNonVulnerable.
`Boolean`	`isRubygemsAnalyzerEnabled()` Get the value of rubygemsAnalyzerEnabled.
`boolean`	`isShowSummary()` Get the value of showSummary.
`Boolean`	`isSwiftPackageManagerAnalyzerEnabled()` Returns whether or not the Swift package Analyzer is enabled.
`boolean`	`isUpdateOnly()` Deprecated. Use the update task instead
`protected void`	`populateSettings()` Takes the properties supplied and updates the dependency-check settings.
`void`	`setApplicationName(String applicationName)` Deprecated. use projectName instead.
`void`	`setArchiveAnalyzerEnabled(Boolean archiveAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setArtifactoryAnalyzerApiToken(String artifactoryAnalyzerApiToken)` Set the value of artifactoryAnalyzerApiToken.
`void`	`setArtifactoryAnalyzerBearerToken(String artifactoryAnalyzerBearerToken)` Set the value of artifactoryAnalyzerBearerToken.
`void`	`setArtifactoryAnalyzerEnabled(Boolean artifactoryAnalyzerEnabled)` Set the value of artifactoryAnalyzerEnabled.
`void`	`setArtifactoryAnalyzerParallelAnalysis(Boolean artifactoryAnalyzerParallelAnalysis)` Set the value of artifactoryAnalyzerParallelAnalysis.
`void`	`setArtifactoryAnalyzerUrl(String artifactoryAnalyzerUrl)` Set the value of artifactoryAnalyzerUrl.
`void`	`setArtifactoryAnalyzerUseProxy(Boolean artifactoryAnalyzerUseProxy)` Set the value of artifactoryAnalyzerUseProxy.
`void`	`setArtifactoryAnalyzerUsername(String artifactoryAnalyzerUsername)` Set the value of artifactoryAnalyzerUsername.
`void`	`setAssemblyAnalyzerEnabled(Boolean assemblyAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setAutoconfAnalyzerEnabled(Boolean autoconfAnalyzerEnabled)` Set the value of autoconfAnalyzerEnabled.
`void`	`setAutoUpdate(Boolean autoUpdate)` Set the value of autoUpdate.
`void`	`setBundleAuditAnalyzerEnabled(Boolean bundleAuditAnalyzerEnabled)` Sets if the Bundle Audit Analyzer is enabled.
`void`	`setBundleAuditPath(String bundleAuditPath)` Sets the path to the bundle audit executable.
`void`	`setCentralAnalyzerEnabled(Boolean centralAnalyzerEnabled)` Set the value of centralAnalyzerEnabled.
`void`	`setCmakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled)` Set the value of cmakeAnalyzerEnabled.
`void`	`setCMakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled)` Set the value of cmakeAnalyzerEnabled.
`void`	`setCocoapodsAnalyzerEnabled(Boolean cocoapodsAnalyzerEnabled)` Sets whether or not the cocoapods analyzer is enabled.
`void`	`setComposerAnalyzerEnabled(Boolean composerAnalyzerEnabled)` Set the value of composerAnalyzerEnabled.
`void`	`setEnableExperimental(Boolean enableExperimental)` Set the value of enableExperimental.
`void`	`setEnableRetired(Boolean enableRetired)` Set the value of enableRetired.
`void`	`setFailBuildOnCVSS(float failBuildOnCVSS)` Set the value of failBuildOnCVSS.
`void`	`setHintsFile(String hintsFile)` Set the value of hintsFile.
`void`	`setJarAnalyzerEnabled(Boolean jarAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setNexusAnalyzerEnabled(Boolean nexusAnalyzerEnabled)` Set the value of nexusAnalyzerEnabled.
`void`	`setNexusUrl(String nexusUrl)` Set the value of nexusUrl.
`void`	`setNexusUsesProxy(Boolean nexusUsesProxy)` Set the value of nexusUsesProxy.
`void`	`setNodeAnalyzerEnabled(Boolean nodeAnalyzerEnabled)` Set the value of nodeAnalyzerEnabled.
`void`	`setNspAnalyzerEnabled(Boolean nspAnalyzerEnabled)` Set the value of nspAnalyzerEnabled.
`void`	`setNuspecAnalyzerEnabled(Boolean nuspecAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setOpensslAnalyzerEnabled(Boolean opensslAnalyzerEnabled)` Set the value of opensslAnalyzerEnabled.
`void`	`setPathToMono(String pathToMono)` Set the value of pathToMono.
`void`	`setProjectName(String projectName)` Set the value of projectName.
`void`	`setPyDistributionAnalyzerEnabled(Boolean pyDistributionAnalyzerEnabled)` Set the value of pyDistributionAnalyzerEnabled.
`void`	`setPyPackageAnalyzerEnabled(Boolean pyPackageAnalyzerEnabled)` Set the value of pyPackageAnalyzerEnabled.
`void`	`setRefId(org.apache.tools.ant.types.Reference r)` Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
`void`	`setReportFormat(Check.ReportFormats reportFormat)` Set the value of reportFormat.
`void`	`setReportOutputDirectory(String reportOutputDirectory)` Set the value of reportOutputDirectory.
`void`	`setRetireJsAnalyzerEnabled(Boolean retireJsAnalyzerEnabled)` Set the value of retireJsAnalyzerEnabled.
`void`	`setRetirejsFilterNonVulnerable(Boolean retirejsFilterNonVulnerable)` Set the value of retirejsFilterNonVulnerable.
`void`	`setRubygemsAnalyzerEnabled(Boolean rubygemsAnalyzerEnabled)` Set the value of rubygemsAnalyzerEnabled.
`void`	`setShowSummary(boolean showSummary)` Set the value of showSummary.
`void`	`setSuppressionFile(String suppressionFile)` Set the value of suppressionFile.
`void`	`setSwiftPackageManagerAnalyzerEnabled(Boolean swiftPackageManagerAnalyzerEnabled)` Sets the enabled state of the swift package manager analyzer.
`void`	`setUpdateOnly(boolean updateOnly)` Deprecated. Use the update task instead
`void`	`setZipExtensions(String zipExtensions)` Set the value of zipExtensions.

Methods inherited from class org.owasp.dependencycheck.taskdefs.Purge
getDataDirectory, getSettings, isFailOnError, setDataDirectory, setFailOnError

Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Check
```
public Check()
```
    Construct a new DependencyCheckTask.
- Method Detail
  - add
```
public void add(org.apache.tools.ant.types.ResourceCollection rc)
```
    Add an arbitrary ResourceCollection.
    
    Parameters:
    
    rc - the ResourceCollection to add.
    
    Since:
    
    Ant 1.7
  - addConfiguredSuppressionFile
```
public void addConfiguredSuppressionFile(SuppressionFile suppressionFile)
```
    Add a suppression file. This is called by Ant with the configured SuppressionFile.
    
    Parameters:
    
    suppressionFile - the suppression file to add.
  - isReference
```
public boolean isReference()
```
    Learn whether the refId attribute of this element been set.
    
    Returns:
    
    true if refId is valid.
  - setRefId
```
public void setRefId(org.apache.tools.ant.types.Reference r)
```
    Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
    
    Parameters:
    
    r - the reference to a path, fileset, dirset or filelist.
  - getApplicationName
```
@Deprecated
public String getApplicationName()
```
    Deprecated. use projectName instead.
    
    Get the value of applicationName.
    
    Returns:
    
    the value of applicationName
  - setApplicationName
```
@Deprecated
public void setApplicationName(String applicationName)
```
    Deprecated. use projectName instead.
    
    Set the value of applicationName.
    
    Parameters:
    
    applicationName - new value of applicationName
  - getProjectName
```
public String getProjectName()
```
    Get the value of projectName.
    
    Returns:
    
    the value of projectName
  - setProjectName
```
public void setProjectName(String projectName)
```
    Set the value of projectName.
    
    Parameters:
    
    projectName - new value of projectName
  - getReportOutputDirectory
```
public String getReportOutputDirectory()
```
    Get the value of reportOutputDirectory.
    
    Returns:
    
    the value of reportOutputDirectory
  - setReportOutputDirectory
```
public void setReportOutputDirectory(String reportOutputDirectory)
```
    Set the value of reportOutputDirectory.
    
    Parameters:
    
    reportOutputDirectory - new value of reportOutputDirectory
  - getFailBuildOnCVSS
```
public float getFailBuildOnCVSS()
```
    Get the value of failBuildOnCVSS.
    
    Returns:
    
    the value of failBuildOnCVSS
  - setFailBuildOnCVSS
```
public void setFailBuildOnCVSS(float failBuildOnCVSS)
```
    Set the value of failBuildOnCVSS.
    
    Parameters:
    
    failBuildOnCVSS - new value of failBuildOnCVSS
  - isAutoUpdate
```
public Boolean isAutoUpdate()
```
    Get the value of autoUpdate.
    
    Returns:
    
    the value of autoUpdate
  - setAutoUpdate
```
public void setAutoUpdate(Boolean autoUpdate)
```
    Set the value of autoUpdate.
    
    Parameters:
    
    autoUpdate - new value of autoUpdate
  - isUpdateOnly
```
@Deprecated
public boolean isUpdateOnly()
```
    Deprecated. Use the update task instead
    
    Get the value of updateOnly.
    
    Returns:
    
    the value of updateOnly
  - setUpdateOnly
```
@Deprecated
public void setUpdateOnly(boolean updateOnly)
```
    Deprecated. Use the update task instead
    
    Set the value of updateOnly.
    
    Parameters:
    
    updateOnly - new value of updateOnly
  - getReportFormat
```
public String getReportFormat()
```
    Get the value of reportFormat.
    
    Returns:
    
    the value of reportFormat
  - setReportFormat
```
public void setReportFormat(Check.ReportFormats reportFormat)
```
    Set the value of reportFormat.
    
    Parameters:
    
    reportFormat - new value of reportFormat
  - getSuppressionFiles
```
public List<String> getSuppressionFiles()
```
    Gets suppression file paths.
    
    Returns:
    
    the suppression files.
  - setSuppressionFile
```
public void setSuppressionFile(String suppressionFile)
```
    Set the value of suppressionFile.
    
    Parameters:
    
    suppressionFile - new value of suppressionFile
  - getHintsFile
```
public String getHintsFile()
```
    Get the value of hintsFile.
    
    Returns:
    
    the value of hintsFile
  - setHintsFile
```
public void setHintsFile(String hintsFile)
```
    Set the value of hintsFile.
    
    Parameters:
    
    hintsFile - new value of hintsFile
  - isShowSummary
```
public boolean isShowSummary()
```
    Get the value of showSummary.
    
    Returns:
    
    the value of showSummary
  - setShowSummary
```
public void setShowSummary(boolean showSummary)
```
    Set the value of showSummary.
    
    Parameters:
    
    showSummary - new value of showSummary
  - isEnableExperimental
```
public Boolean isEnableExperimental()
```
    Get the value of enableExperimental.
    
    Returns:
    
    the value of enableExperimental
  - setEnableExperimental
```
public void setEnableExperimental(Boolean enableExperimental)
```
    Set the value of enableExperimental.
    
    Parameters:
    
    enableExperimental - new value of enableExperimental
  - isEnableRetired
```
public Boolean isEnableRetired()
```
    Get the value of enableRetired.
    
    Returns:
    
    the value of enableRetired
  - setEnableRetired
```
public void setEnableRetired(Boolean enableRetired)
```
    Set the value of enableRetired.
    
    Parameters:
    
    enableRetired - new value of enableRetired
  - isJarAnalyzerEnabled
```
public Boolean isJarAnalyzerEnabled()
```
    Returns whether or not the analyzer is enabled.
    
    Returns:
    
    true if the analyzer is enabled
  - setJarAnalyzerEnabled
```
public void setJarAnalyzerEnabled(Boolean jarAnalyzerEnabled)
```
    Sets whether or not the analyzer is enabled.
    
    Parameters:
    
    jarAnalyzerEnabled - the value of the new setting
  - isArchiveAnalyzerEnabled
```
public Boolean isArchiveAnalyzerEnabled()
```
    Returns whether or not the analyzer is enabled.
    
    Returns:
    
    true if the analyzer is enabled
  - setArchiveAnalyzerEnabled
```
public void setArchiveAnalyzerEnabled(Boolean archiveAnalyzerEnabled)
```
    Sets whether or not the analyzer is enabled.
    
    Parameters:
    
    archiveAnalyzerEnabled - the value of the new setting
  - isAssemblyAnalyzerEnabled
```
public Boolean isAssemblyAnalyzerEnabled()
```
    Returns whether or not the analyzer is enabled.
    
    Returns:
    
    true if the analyzer is enabled
  - setAssemblyAnalyzerEnabled
```
public void setAssemblyAnalyzerEnabled(Boolean assemblyAnalyzerEnabled)
```
    Sets whether or not the analyzer is enabled.
    
    Parameters:
    
    assemblyAnalyzerEnabled - the value of the new setting
  - isNuspecAnalyzerEnabled
```
public Boolean isNuspecAnalyzerEnabled()
```
    Returns whether or not the analyzer is enabled.
    
    Returns:
    
    true if the analyzer is enabled
  - setNuspecAnalyzerEnabled
```
public void setNuspecAnalyzerEnabled(Boolean nuspecAnalyzerEnabled)
```
    Sets whether or not the analyzer is enabled.
    
    Parameters:
    
    nuspecAnalyzerEnabled - the value of the new setting
  - isComposerAnalyzerEnabled
```
public Boolean isComposerAnalyzerEnabled()
```
    Get the value of composerAnalyzerEnabled.
    
    Returns:
    
    the value of composerAnalyzerEnabled
  - setComposerAnalyzerEnabled
```
public void setComposerAnalyzerEnabled(Boolean composerAnalyzerEnabled)
```
    Set the value of composerAnalyzerEnabled.
    
    Parameters:
    
    composerAnalyzerEnabled - new value of composerAnalyzerEnabled
  - isAutoconfAnalyzerEnabled
```
public Boolean isAutoconfAnalyzerEnabled()
```
    Get the value of autoconfAnalyzerEnabled.
    
    Returns:
    
    the value of autoconfAnalyzerEnabled
  - setAutoconfAnalyzerEnabled
```
public void setAutoconfAnalyzerEnabled(Boolean autoconfAnalyzerEnabled)
```
    Set the value of autoconfAnalyzerEnabled.
    
    Parameters:
    
    autoconfAnalyzerEnabled - new value of autoconfAnalyzerEnabled
  - isCMakeAnalyzerEnabled
```
public Boolean isCMakeAnalyzerEnabled()
```
    Get the value of cmakeAnalyzerEnabled.
    
    Returns:
    
    the value of cmakeAnalyzerEnabled
  - setCMakeAnalyzerEnabled
```
public void setCMakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled)
```
    Set the value of cmakeAnalyzerEnabled.
    
    Parameters:
    
    cmakeAnalyzerEnabled - new value of cmakeAnalyzerEnabled
  - isBundleAuditAnalyzerEnabled
```
public Boolean isBundleAuditAnalyzerEnabled()
```
    Returns if the Bundle Audit Analyzer is enabled.
    
    Returns:
    
    if the Bundle Audit Analyzer is enabled.
  - setBundleAuditAnalyzerEnabled
```
public void setBundleAuditAnalyzerEnabled(Boolean bundleAuditAnalyzerEnabled)
```
    Sets if the Bundle Audit Analyzer is enabled.
    
    Parameters:
    
    bundleAuditAnalyzerEnabled - whether or not the analyzer should be enabled
  - getBundleAuditPath
```
public String getBundleAuditPath()
```
    Returns the path to the bundle audit executable.
    
    Returns:
    
    the path to the bundle audit executable
  - setBundleAuditPath
```
public void setBundleAuditPath(String bundleAuditPath)
```
    Sets the path to the bundle audit executable.
    
    Parameters:
    
    bundleAuditPath - the path to the bundle audit executable
  - isCocoapodsAnalyzerEnabled
```
public boolean isCocoapodsAnalyzerEnabled()
```
    Returns if the cocoapods analyzer is enabled.
    
    Returns:
    
    if the cocoapods analyzer is enabled
  - setCocoapodsAnalyzerEnabled
```
public void setCocoapodsAnalyzerEnabled(Boolean cocoapodsAnalyzerEnabled)
```
    Sets whether or not the cocoapods analyzer is enabled.
    
    Parameters:
    
    cocoapodsAnalyzerEnabled - the state of the cocoapods analyzer
  - isSwiftPackageManagerAnalyzerEnabled
```
public Boolean isSwiftPackageManagerAnalyzerEnabled()
```
    Returns whether or not the Swift package Analyzer is enabled.
    
    Returns:
    
    whether or not the Swift package Analyzer is enabled
  - setSwiftPackageManagerAnalyzerEnabled
```
public void setSwiftPackageManagerAnalyzerEnabled(Boolean swiftPackageManagerAnalyzerEnabled)
```
    Sets the enabled state of the swift package manager analyzer.
    
    Parameters:
    
    swiftPackageManagerAnalyzerEnabled - the enabled state of the swift package manager
  - isOpensslAnalyzerEnabled
```
public Boolean isOpensslAnalyzerEnabled()
```
    Get the value of opensslAnalyzerEnabled.
    
    Returns:
    
    the value of opensslAnalyzerEnabled
  - setOpensslAnalyzerEnabled
```
public void setOpensslAnalyzerEnabled(Boolean opensslAnalyzerEnabled)
```
    Set the value of opensslAnalyzerEnabled.
    
    Parameters:
    
    opensslAnalyzerEnabled - new value of opensslAnalyzerEnabled
  - isNodeAnalyzerEnabled
```
public Boolean isNodeAnalyzerEnabled()
```
    Get the value of nodeAnalyzerEnabled.
    
    Returns:
    
    the value of nodeAnalyzerEnabled
  - setNodeAnalyzerEnabled
```
public void setNodeAnalyzerEnabled(Boolean nodeAnalyzerEnabled)
```
    Set the value of nodeAnalyzerEnabled.
    
    Parameters:
    
    nodeAnalyzerEnabled - new value of nodeAnalyzerEnabled
  - isNspAnalyzerEnabled
```
public Boolean isNspAnalyzerEnabled()
```
    Get the value of nspAnalyzerEnabled.
    
    Returns:
    
    the value of nspAnalyzerEnabled
  - setNspAnalyzerEnabled
```
public void setNspAnalyzerEnabled(Boolean nspAnalyzerEnabled)
```
    Set the value of nspAnalyzerEnabled.
    
    Parameters:
    
    nspAnalyzerEnabled - new value of nspAnalyzerEnabled
  - isRetireJsAnalyzerEnabled
```
public Boolean isRetireJsAnalyzerEnabled()
```
    Get the value of retireJsAnalyzerEnabled.
    
    Returns:
    
    the value of retireJsAnalyzerEnabled
  - setRetireJsAnalyzerEnabled
```
public void setRetireJsAnalyzerEnabled(Boolean retireJsAnalyzerEnabled)
```
    Set the value of retireJsAnalyzerEnabled.
    
    Parameters:
    
    retireJsAnalyzerEnabled - new value of retireJsAnalyzerEnabled
  - isRetirejsFilterNonVulnerable
```
public Boolean isRetirejsFilterNonVulnerable()
```
    Get the value of retirejsFilterNonVulnerable.
    
    Returns:
    
    the value of retirejsFilterNonVulnerable
  - setRetirejsFilterNonVulnerable
```
public void setRetirejsFilterNonVulnerable(Boolean retirejsFilterNonVulnerable)
```
    Set the value of retirejsFilterNonVulnerable.
    
    Parameters:
    
    retirejsFilterNonVulnerable - new value of retirejsFilterNonVulnerable
  - getRetirejsFilters
```
public List<String> getRetirejsFilters()
```
    Gets retire JS Analyzers file content filters.
    
    Returns:
    
    retire JS Analyzers file content filters
  - addConfiguredRetirejsFilter
```
public void addConfiguredRetirejsFilter(RetirejsFilter retirejsFilter)
```
    Add a regular expression to the set of retire JS content filters. This is called by Ant.
    
    Parameters:
    
    retirejsFilter - the regular expression used to filter based on file content
  - isRubygemsAnalyzerEnabled
```
public Boolean isRubygemsAnalyzerEnabled()
```
    Get the value of rubygemsAnalyzerEnabled.
    
    Returns:
    
    the value of rubygemsAnalyzerEnabled
  - setRubygemsAnalyzerEnabled
```
public void setRubygemsAnalyzerEnabled(Boolean rubygemsAnalyzerEnabled)
```
    Set the value of rubygemsAnalyzerEnabled.
    
    Parameters:
    
    rubygemsAnalyzerEnabled - new value of rubygemsAnalyzerEnabled
  - isPyPackageAnalyzerEnabled
```
public Boolean isPyPackageAnalyzerEnabled()
```
    Get the value of pyPackageAnalyzerEnabled.
    
    Returns:
    
    the value of pyPackageAnalyzerEnabled
  - setPyPackageAnalyzerEnabled
```
public void setPyPackageAnalyzerEnabled(Boolean pyPackageAnalyzerEnabled)
```
    Set the value of pyPackageAnalyzerEnabled.
    
    Parameters:
    
    pyPackageAnalyzerEnabled - new value of pyPackageAnalyzerEnabled
  - isPyDistributionAnalyzerEnabled
```
public Boolean isPyDistributionAnalyzerEnabled()
```
    Get the value of pyDistributionAnalyzerEnabled.
    
    Returns:
    
    the value of pyDistributionAnalyzerEnabled
  - setPyDistributionAnalyzerEnabled
```
public void setPyDistributionAnalyzerEnabled(Boolean pyDistributionAnalyzerEnabled)
```
    Set the value of pyDistributionAnalyzerEnabled.
    
    Parameters:
    
    pyDistributionAnalyzerEnabled - new value of pyDistributionAnalyzerEnabled
  - isCentralAnalyzerEnabled
```
public Boolean isCentralAnalyzerEnabled()
```
    Get the value of centralAnalyzerEnabled.
    
    Returns:
    
    the value of centralAnalyzerEnabled
  - setCentralAnalyzerEnabled
```
public void setCentralAnalyzerEnabled(Boolean centralAnalyzerEnabled)
```
    Set the value of centralAnalyzerEnabled.
    
    Parameters:
    
    centralAnalyzerEnabled - new value of centralAnalyzerEnabled
  - isNexusAnalyzerEnabled
```
public Boolean isNexusAnalyzerEnabled()
```
    Get the value of nexusAnalyzerEnabled.
    
    Returns:
    
    the value of nexusAnalyzerEnabled
  - setNexusAnalyzerEnabled
```
public void setNexusAnalyzerEnabled(Boolean nexusAnalyzerEnabled)
```
    Set the value of nexusAnalyzerEnabled.
    
    Parameters:
    
    nexusAnalyzerEnabled - new value of nexusAnalyzerEnabled
  - getNexusUrl
```
public String getNexusUrl()
```
    Get the value of nexusUrl.
    
    Returns:
    
    the value of nexusUrl
  - setNexusUrl
```
public void setNexusUrl(String nexusUrl)
```
    Set the value of nexusUrl.
    
    Parameters:
    
    nexusUrl - new value of nexusUrl
  - isNexusUsesProxy
```
public Boolean isNexusUsesProxy()
```
    Get the value of nexusUsesProxy.
    
    Returns:
    
    the value of nexusUsesProxy
  - setNexusUsesProxy
```
public void setNexusUsesProxy(Boolean nexusUsesProxy)
```
    Set the value of nexusUsesProxy.
    
    Parameters:
    
    nexusUsesProxy - new value of nexusUsesProxy
  - getZipExtensions
```
public String getZipExtensions()
```
    Get the value of zipExtensions.
    
    Returns:
    
    the value of zipExtensions
  - setZipExtensions
```
public void setZipExtensions(String zipExtensions)
```
    Set the value of zipExtensions.
    
    Parameters:
    
    zipExtensions - new value of zipExtensions
  - getPathToMono
```
public String getPathToMono()
```
    Get the value of pathToMono.
    
    Returns:
    
    the value of pathToMono
  - setPathToMono
```
public void setPathToMono(String pathToMono)
```
    Set the value of pathToMono.
    
    Parameters:
    
    pathToMono - new value of pathToMono
  - getCmakeAnalyzerEnabled
```
public Boolean getCmakeAnalyzerEnabled()
```
    Returns the value of cmakeAnalyzerEnabled.
    
    Returns:
    
    the value of cmakeAnalyzerEnabled
  - setCmakeAnalyzerEnabled
```
public void setCmakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled)
```
    Set the value of cmakeAnalyzerEnabled.
    
    Parameters:
    
    cmakeAnalyzerEnabled - new value of cmakeAnalyzerEnabled
  - getArtifactoryAnalyzerEnabled
```
public Boolean getArtifactoryAnalyzerEnabled()
```
    Returns the value of artifactoryAnalyzerEnabled.
    
    Returns:
    
    the value of artifactoryAnalyzerEnabled
  - setArtifactoryAnalyzerEnabled
```
public void setArtifactoryAnalyzerEnabled(Boolean artifactoryAnalyzerEnabled)
```
    Set the value of artifactoryAnalyzerEnabled.
    
    Parameters:
    
    artifactoryAnalyzerEnabled - new value of artifactoryAnalyzerEnabled
  - getArtifactoryAnalyzerUrl
```
public String getArtifactoryAnalyzerUrl()
```
    Returns the value of artifactoryAnalyzerUrl.
    
    Returns:
    
    the value of artifactoryAnalyzerUrl
  - setArtifactoryAnalyzerUrl
```
public void setArtifactoryAnalyzerUrl(String artifactoryAnalyzerUrl)
```
    Set the value of artifactoryAnalyzerUrl.
    
    Parameters:
    
    artifactoryAnalyzerUrl - new value of artifactoryAnalyzerUrl
  - getArtifactoryAnalyzerUseProxy
```
public Boolean getArtifactoryAnalyzerUseProxy()
```
    Returns the value of artifactoryAnalyzerUseProxy.
    
    Returns:
    
    the value of artifactoryAnalyzerUseProxy
  - setArtifactoryAnalyzerUseProxy
```
public void setArtifactoryAnalyzerUseProxy(Boolean artifactoryAnalyzerUseProxy)
```
    Set the value of artifactoryAnalyzerUseProxy.
    
    Parameters:
    
    artifactoryAnalyzerUseProxy - new value of artifactoryAnalyzerUseProxy
  - getArtifactoryAnalyzerParallelAnalysis
```
public Boolean getArtifactoryAnalyzerParallelAnalysis()
```
    Returns the value of artifactoryAnalyzerParallelAnalysis.
    
    Returns:
    
    the value of artifactoryAnalyzerParallelAnalysis
  - setArtifactoryAnalyzerParallelAnalysis
```
public void setArtifactoryAnalyzerParallelAnalysis(Boolean artifactoryAnalyzerParallelAnalysis)
```
    Set the value of artifactoryAnalyzerParallelAnalysis.
    
    Parameters:
    
    artifactoryAnalyzerParallelAnalysis - new value of artifactoryAnalyzerParallelAnalysis
  - getArtifactoryAnalyzerUsername
```
public String getArtifactoryAnalyzerUsername()
```
    Returns the value of artifactoryAnalyzerUsername.
    
    Returns:
    
    the value of artifactoryAnalyzerUsername
  - setArtifactoryAnalyzerUsername
```
public void setArtifactoryAnalyzerUsername(String artifactoryAnalyzerUsername)
```
    Set the value of artifactoryAnalyzerUsername.
    
    Parameters:
    
    artifactoryAnalyzerUsername - new value of artifactoryAnalyzerUsername
  - getArtifactoryAnalyzerApiToken
```
public String getArtifactoryAnalyzerApiToken()
```
    Returns the value of artifactoryAnalyzerApiToken.
    
    Returns:
    
    the value of artifactoryAnalyzerApiToken
  - setArtifactoryAnalyzerApiToken
```
public void setArtifactoryAnalyzerApiToken(String artifactoryAnalyzerApiToken)
```
    Set the value of artifactoryAnalyzerApiToken.
    
    Parameters:
    
    artifactoryAnalyzerApiToken - new value of artifactoryAnalyzerApiToken
  - getArtifactoryAnalyzerBearerToken
```
public String getArtifactoryAnalyzerBearerToken()
```
    Returns the value of artifactoryAnalyzerBearerToken.
    
    Returns:
    
    the value of artifactoryAnalyzerBearerToken
  - setArtifactoryAnalyzerBearerToken
```
public void setArtifactoryAnalyzerBearerToken(String artifactoryAnalyzerBearerToken)
```
    Set the value of artifactoryAnalyzerBearerToken.
    
    Parameters:
    
    artifactoryAnalyzerBearerToken - new value of artifactoryAnalyzerBearerToken
  - execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
    Description copied from class: Update
    
    Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the local database.
    
    Overrides:
    
    execute in class Update
    
    Throws:
    
    org.apache.tools.ant.BuildException - thrown if a connection to the local database cannot be made.
  - populateSettings
```
protected void populateSettings()
                         throws org.apache.tools.ant.BuildException
```
    Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system properties required to change the proxy server, port, and connection timeout.
    
    Overrides:
    
    populateSettings in class Update
    
    Throws:
    
    org.apache.tools.ant.BuildException - thrown when an invalid setting is configured.

Class Check

Nested Class Summary

Field Summary

Fields inherited from class org.apache.tools.ant.Task

Fields inherited from class org.apache.tools.ant.ProjectComponent

Constructor Summary

Method Summary

Methods inherited from class org.owasp.dependencycheck.taskdefs.Update

Methods inherited from class org.owasp.dependencycheck.taskdefs.Purge

Methods inherited from class org.apache.tools.ant.Task

Methods inherited from class org.apache.tools.ant.ProjectComponent

Methods inherited from class java.lang.Object

Constructor Detail

Check

Method Detail

add

addConfiguredSuppressionFile

isReference

setRefId

getApplicationName

setApplicationName

getProjectName

setProjectName

getReportOutputDirectory

setReportOutputDirectory

getFailBuildOnCVSS

setFailBuildOnCVSS

isAutoUpdate

setAutoUpdate

isUpdateOnly

setUpdateOnly

getReportFormat

setReportFormat

getSuppressionFiles

setSuppressionFile

getHintsFile

setHintsFile

isShowSummary

setShowSummary

isEnableExperimental

setEnableExperimental

isEnableRetired

setEnableRetired

isJarAnalyzerEnabled

setJarAnalyzerEnabled

isArchiveAnalyzerEnabled

setArchiveAnalyzerEnabled

isAssemblyAnalyzerEnabled

setAssemblyAnalyzerEnabled

isNuspecAnalyzerEnabled

setNuspecAnalyzerEnabled

isComposerAnalyzerEnabled

setComposerAnalyzerEnabled

isAutoconfAnalyzerEnabled

setAutoconfAnalyzerEnabled

isCMakeAnalyzerEnabled

setCMakeAnalyzerEnabled

isBundleAuditAnalyzerEnabled

setBundleAuditAnalyzerEnabled

getBundleAuditPath

setBundleAuditPath

isCocoapodsAnalyzerEnabled

setCocoapodsAnalyzerEnabled

isSwiftPackageManagerAnalyzerEnabled

setSwiftPackageManagerAnalyzerEnabled

isOpensslAnalyzerEnabled

setOpensslAnalyzerEnabled

isNodeAnalyzerEnabled

setNodeAnalyzerEnabled

isNspAnalyzerEnabled

setNspAnalyzerEnabled

isRetireJsAnalyzerEnabled

setRetireJsAnalyzerEnabled

isRetirejsFilterNonVulnerable

setRetirejsFilterNonVulnerable

getRetirejsFilters

addConfiguredRetirejsFilter

isRubygemsAnalyzerEnabled

setRubygemsAnalyzerEnabled

isPyPackageAnalyzerEnabled