DependencyCheckTask (Dependency-Check Ant Task 1.2.11 API)

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - org.owasp.dependencycheck.taskdefs.DependencyCheckTask

All Implemented Interfaces:

Cloneable
```
public class DependencyCheckTask
extends org.apache.tools.ant.Task
```
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 DependencyCheckTask.ReportFormats
An enumeration of supported report formats: "ALL", "HTML", "XML", "VULN", etc..

Nested Classes
Modifier and Type	Class and Description
`static class`	`DependencyCheckTask.ReportFormats` An enumeration of supported report formats: "ALL", "HTML", "XML", "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

DependencyCheckTask()
Construct a new DependencyCheckTask.

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(org.apache.tools.ant.types.ResourceCollection rc)` Add an arbitrary ResourceCollection.
`void`	`execute()`
`String`	`getApplicationName()` Get the value of applicationName.
`String`	`getConnectionString()` Get the value of connectionString.
`String`	`getConnectionTimeout()` Get the value of connectionTimeout.
`String`	`getCveUrl12Base()` Get the value of cveUrl12Base.
`String`	`getCveUrl12Modified()` Get the value of cveUrl12Modified.
`String`	`getCveUrl20Base()` Get the value of cveUrl20Base.
`String`	`getCveUrl20Modified()` Get the value of cveUrl20Modified.
`String`	`getDatabaseDriverName()` Get the value of databaseDriverName.
`String`	`getDatabaseDriverPath()` Get the value of databaseDriverPath.
`String`	`getDatabasePassword()` Get the value of databasePassword.
`String`	`getDatabaseUser()` Get the value of databaseUser.
`String`	`getDataDirectory()` Get the value of dataDirectory.
`float`	`getFailBuildOnCVSS()` Get the value of failBuildOnCVSS.
`String`	`getLogFile()` Get the value of logFile.
`String`	`getNexusUrl()` Get the value of nexusUrl.
`String`	`getPathToMono()` Get the value of pathToMono.
`String`	`getProxyPassword()` Get the value of proxyPassword.
`String`	`getProxyPort()` Get the value of proxyPort.
`String`	`getProxyServer()` Get the value of proxyServer.
`String`	`getProxyUrl()` Deprecated. use `getProxyServer()` instead
`String`	`getProxyUsername()` Get the value of proxyUsername.
`String`	`getReportFormat()` Get the value of reportFormat.
`String`	`getReportOutputDirectory()` Get the value of reportOutputDirectory.
`String`	`getSuppressionFile()` Get the value of suppressionFile.
`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`	`isAutoUpdate()` Get the value of autoUpdate.
`boolean`	`isCentralAnalyzerEnabled()` Get the value of centralAnalyzerEnabled.
`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`	`isNuspecAnalyzerEnabled()` Returns whether or not the analyzer is enabled.
`boolean`	`isReference()` Learn whether the refid attribute of this element been set.
`boolean`	`isShowSummary()` Get the value of showSummary.
`boolean`	`isUpdateOnly()` Get the value of updateOnly.
`void`	`setApplicationName(String applicationName)` Set the value of applicationName.
`void`	`setArchiveAnalyzerEnabled(boolean archiveAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setAssemblyAnalyzerEnabled(boolean assemblyAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setAutoUpdate(boolean autoUpdate)` Set the value of autoUpdate.
`void`	`setCentralAnalyzerEnabled(boolean centralAnalyzerEnabled)` Set the value of centralAnalyzerEnabled.
`void`	`setConnectionString(String connectionString)` Set the value of connectionString.
`void`	`setConnectionTimeout(String connectionTimeout)` Set the value of connectionTimeout.
`void`	`setCveUrl12Base(String cveUrl12Base)` Set the value of cveUrl12Base.
`void`	`setCveUrl12Modified(String cveUrl12Modified)` Set the value of cveUrl12Modified.
`void`	`setCveUrl20Base(String cveUrl20Base)` Set the value of cveUrl20Base.
`void`	`setCveUrl20Modified(String cveUrl20Modified)` Set the value of cveUrl20Modified.
`void`	`setDatabaseDriverName(String databaseDriverName)` Set the value of databaseDriverName.
`void`	`setDatabaseDriverPath(String databaseDriverPath)` Set the value of databaseDriverPath.
`void`	`setDatabasePassword(String databasePassword)` Set the value of databasePassword.
`void`	`setDatabaseUser(String databaseUser)` Set the value of databaseUser.
`void`	`setDataDirectory(String dataDirectory)` Set the value of dataDirectory.
`void`	`setFailBuildOnCVSS(float failBuildOnCVSS)` Set the value of failBuildOnCVSS.
`void`	`setJarAnalyzerEnabled(boolean jarAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setLogFile(String logFile)` Set the value of logFile.
`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`	`setNuspecAnalyzerEnabled(boolean nuspecAnalyzerEnabled)` Sets whether or not the analyzer is enabled.
`void`	`setPathToMono(String pathToMono)` Set the value of pathToMono.
`void`	`setProxyPassword(String proxyPassword)` Set the value of proxyPassword.
`void`	`setProxyPort(String proxyPort)` Set the value of proxyPort.
`void`	`setProxyServer(String server)` Set the value of proxyServer.
`void`	`setProxyUrl(String proxyUrl)` Deprecated. use `setProxyServer(java.lang.String)` instead
`void`	`setProxyUsername(String proxyUsername)` Set the value of proxyUsername.
`void`	`setRefid(org.apache.tools.ant.types.Reference r)` Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
`void`	`setReportFormat(DependencyCheckTask.ReportFormats reportFormat)` Set the value of reportFormat.
`void`	`setReportOutputDirectory(String reportOutputDirectory)` Set the value of reportOutputDirectory.
`void`	`setShowSummary(boolean showSummary)` Set the value of showSummary.
`void`	`setSuppressionFile(String suppressionFile)` Set the value of suppressionFile.
`void`	`setUpdateOnly(boolean updateOnly)` Set the value of updateOnly.
`void`	`setZipExtensions(String zipExtensions)` Set the value of zipExtensions.

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
  - DependencyCheckTask
```
public DependencyCheckTask()
```
    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
  - 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
```
public String getApplicationName()
```
    Get the value of applicationName.
    
    Returns:
    the value of applicationName
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
    Set the value of applicationName.
    
    Parameters:
    applicationName - new value of applicationName
  - getDataDirectory
```
public String getDataDirectory()
```
    Get the value of dataDirectory.
    
    Returns:
    the value of dataDirectory
  - setDataDirectory
```
public void setDataDirectory(String dataDirectory)
```
    Set the value of dataDirectory.
    
    Parameters:
    dataDirectory - new value of dataDirectory
  - 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
```
public boolean isUpdateOnly()
```
    Get the value of updateOnly.
    
    Returns:
    the value of updateOnly
  - setUpdateOnly
```
public void setUpdateOnly(boolean updateOnly)
```
    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(DependencyCheckTask.ReportFormats reportFormat)
```
    Set the value of reportFormat.
    
    Parameters:
    reportFormat - new value of reportFormat
  - getProxyServer
```
public String getProxyServer()
```
    Get the value of proxyServer.
    
    Returns:
    the value of proxyServer
  - setProxyServer
```
public void setProxyServer(String server)
```
    Set the value of proxyServer.
    
    Parameters:
    server - new value of proxyServer
  - getProxyUrl
```
@Deprecated
public String getProxyUrl()
```
    Deprecated. use getProxyServer() instead
    
    Get the value of proxyServer.
    
    Returns:
    the value of proxyServer
  - setProxyUrl
```
@Deprecated
public void setProxyUrl(String proxyUrl)
```
    Deprecated. use setProxyServer(java.lang.String) instead
    
    Set the value of proxyServer.
    
    Parameters:
    proxyUrl - new value of proxyServer
  - getProxyPort
```
public String getProxyPort()
```
    Get the value of proxyPort.
    
    Returns:
    the value of proxyPort
  - setProxyPort
```
public void setProxyPort(String proxyPort)
```
    Set the value of proxyPort.
    
    Parameters:
    proxyPort - new value of proxyPort
  - getProxyUsername
```
public String getProxyUsername()
```
    Get the value of proxyUsername.
    
    Returns:
    the value of proxyUsername
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Set the value of proxyUsername.
    
    Parameters:
    proxyUsername - new value of proxyUsername
  - getProxyPassword
```
public String getProxyPassword()
```
    Get the value of proxyPassword.
    
    Returns:
    the value of proxyPassword
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Set the value of proxyPassword.
    
    Parameters:
    proxyPassword - new value of proxyPassword
  - getConnectionTimeout
```
public String getConnectionTimeout()
```
    Get the value of connectionTimeout.
    
    Returns:
    the value of connectionTimeout
  - setConnectionTimeout
```
public void setConnectionTimeout(String connectionTimeout)
```
    Set the value of connectionTimeout.
    
    Parameters:
    connectionTimeout - new value of connectionTimeout
  - getLogFile
```
public String getLogFile()
```
    Get the value of logFile.
    
    Returns:
    the value of logFile
  - setLogFile
```
public void setLogFile(String logFile)
```
    Set the value of logFile.
    
    Parameters:
    logFile - new value of logFile
  - getSuppressionFile
```
public String getSuppressionFile()
```
    Get the value of suppressionFile.
    
    Returns:
    the value of suppressionFile
  - setSuppressionFile
```
public void setSuppressionFile(String suppressionFile)
```
    Set the value of suppressionFile.
    
    Parameters:
    suppressionFile - new value of suppressionFile
  - 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
  - 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
  - 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
  - getDatabaseDriverName
```
public String getDatabaseDriverName()
```
    Get the value of databaseDriverName.
    
    Returns:
    the value of databaseDriverName
  - setDatabaseDriverName
```
public void setDatabaseDriverName(String databaseDriverName)
```
    Set the value of databaseDriverName.
    
    Parameters:
    databaseDriverName - new value of databaseDriverName
  - getDatabaseDriverPath
```
public String getDatabaseDriverPath()
```
    Get the value of databaseDriverPath.
    
    Returns:
    the value of databaseDriverPath
  - setDatabaseDriverPath
```
public void setDatabaseDriverPath(String databaseDriverPath)
```
    Set the value of databaseDriverPath.
    
    Parameters:
    databaseDriverPath - new value of databaseDriverPath
  - getConnectionString
```
public String getConnectionString()
```
    Get the value of connectionString.
    
    Returns:
    the value of connectionString
  - setConnectionString
```
public void setConnectionString(String connectionString)
```
    Set the value of connectionString.
    
    Parameters:
    connectionString - new value of connectionString
  - getDatabaseUser
```
public String getDatabaseUser()
```
    Get the value of databaseUser.
    
    Returns:
    the value of databaseUser
  - setDatabaseUser
```
public void setDatabaseUser(String databaseUser)
```
    Set the value of databaseUser.
    
    Parameters:
    databaseUser - new value of databaseUser
  - getDatabasePassword
```
public String getDatabasePassword()
```
    Get the value of databasePassword.
    
    Returns:
    the value of databasePassword
  - setDatabasePassword
```
public void setDatabasePassword(String databasePassword)
```
    Set the value of databasePassword.
    
    Parameters:
    databasePassword - new value of databasePassword
  - 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
  - getCveUrl12Modified
```
public String getCveUrl12Modified()
```
    Get the value of cveUrl12Modified.
    
    Returns:
    the value of cveUrl12Modified
  - setCveUrl12Modified
```
public void setCveUrl12Modified(String cveUrl12Modified)
```
    Set the value of cveUrl12Modified.
    
    Parameters:
    cveUrl12Modified - new value of cveUrl12Modified
  - getCveUrl20Modified
```
public String getCveUrl20Modified()
```
    Get the value of cveUrl20Modified.
    
    Returns:
    the value of cveUrl20Modified
  - setCveUrl20Modified
```
public void setCveUrl20Modified(String cveUrl20Modified)
```
    Set the value of cveUrl20Modified.
    
    Parameters:
    cveUrl20Modified - new value of cveUrl20Modified
  - getCveUrl12Base
```
public String getCveUrl12Base()
```
    Get the value of cveUrl12Base.
    
    Returns:
    the value of cveUrl12Base
  - setCveUrl12Base
```
public void setCveUrl12Base(String cveUrl12Base)
```
    Set the value of cveUrl12Base.
    
    Parameters:
    cveUrl12Base - new value of cveUrl12Base
  - getCveUrl20Base
```
public String getCveUrl20Base()
```
    Get the value of cveUrl20Base.
    
    Returns:
    the value of cveUrl20Base
  - setCveUrl20Base
```
public void setCveUrl20Base(String cveUrl20Base)
```
    Set the value of cveUrl20Base.
    
    Parameters:
    cveUrl20Base - new value of cveUrl20Base
  - 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
  - execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
    Overrides:
    
    execute in class org.apache.tools.ant.Task
    
    Throws:
    
    org.apache.tools.ant.BuildException
  - isJarAnalyzerEnabled
```
public boolean isJarAnalyzerEnabled()
```
    Returns whether or not the analyzer is enabled.
    
    Returns:
    true if the analyzer is enabled

Class DependencyCheckTask

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.apache.tools.ant.Task

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

Methods inherited from class java.lang.Object

Constructor Detail

DependencyCheckTask

Method Detail

add

isReference

setRefid

getApplicationName

setApplicationName

getDataDirectory

setDataDirectory

getReportOutputDirectory

setReportOutputDirectory

getFailBuildOnCVSS

setFailBuildOnCVSS

isAutoUpdate

setAutoUpdate

isUpdateOnly

setUpdateOnly

getReportFormat

setReportFormat

getProxyServer

setProxyServer

getProxyUrl

setProxyUrl

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

getConnectionTimeout

setConnectionTimeout

getLogFile

setLogFile

getSuppressionFile

setSuppressionFile

isShowSummary

setShowSummary

setJarAnalyzerEnabled

isArchiveAnalyzerEnabled

setArchiveAnalyzerEnabled

isAssemblyAnalyzerEnabled

setAssemblyAnalyzerEnabled

isNuspecAnalyzerEnabled

setNuspecAnalyzerEnabled

isCentralAnalyzerEnabled

setCentralAnalyzerEnabled

isNexusAnalyzerEnabled

setNexusAnalyzerEnabled

getNexusUrl

setNexusUrl

isNexusUsesProxy

setNexusUsesProxy

getDatabaseDriverName

setDatabaseDriverName

getDatabaseDriverPath

setDatabaseDriverPath

getConnectionString

setConnectionString

getDatabaseUser

setDatabaseUser

getDatabasePassword

setDatabasePassword

getZipExtensions

setZipExtensions

getCveUrl12Modified

setCveUrl12Modified

getCveUrl20Modified

setCveUrl20Modified

getCveUrl12Base