documentation version 1.2.10

This commit is contained in:
Jeremy Long
2015-04-13 17:43:19 -04:00
parent 480a05c798
commit 9194a42c93
1126 changed files with 34228 additions and 29019 deletions

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Fri Mar 06 06:09:24 EST 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Apr 12 08:15:31 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DependencyCheckTask (Dependency-Check Ant Task 1.2.9 API)</title>
<meta name="date" content="2015-03-06">
<title>DependencyCheckTask (Dependency-Check Ant Task 1.2.10 API)</title>
<meta name="date" content="2015-04-12">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DependencyCheckTask (Dependency-Check Ant Task 1.2.9 API)";
parent.document.title="DependencyCheckTask (Dependency-Check Ant Task 1.2.10 API)";
}
//-->
</script>
@@ -114,7 +114,7 @@
extends org.apache.tools.ant.Task</pre>
<div class="block">An Ant task definition to execute dependency-check during an Ant build.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
<dd>Jeremy Long</dd></dl>
</li>
</ul>
</div>
@@ -418,168 +418,174 @@ extends org.apache.tools.ant.Task</pre>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#isUpdateOnly()">isUpdateOnly</a></strong>()</code>
<div class="block">Get the value of updateOnly</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setApplicationName(java.lang.String)">setApplicationName</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationName)</code>
<div class="block">Set the value of applicationName.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setArchiveAnalyzerEnabled(boolean)">setArchiveAnalyzerEnabled</a></strong>(boolean&nbsp;archiveAnalyzerEnabled)</code>
<div class="block">Sets whether or not the analyzer is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setAssemblyAnalyzerEnabled(boolean)">setAssemblyAnalyzerEnabled</a></strong>(boolean&nbsp;assemblyAnalyzerEnabled)</code>
<div class="block">Sets whether or not the analyzer is enabled.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setAutoUpdate(boolean)">setAutoUpdate</a></strong>(boolean&nbsp;autoUpdate)</code>
<div class="block">Set the value of autoUpdate.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setCentralAnalyzerEnabled(boolean)">setCentralAnalyzerEnabled</a></strong>(boolean&nbsp;centralAnalyzerEnabled)</code>
<div class="block">Set the value of centralAnalyzerEnabled.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setConnectionString(java.lang.String)">setConnectionString</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionString)</code>
<div class="block">Set the value of connectionString.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setConnectionTimeout(java.lang.String)">setConnectionTimeout</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionTimeout)</code>
<div class="block">Set the value of connectionTimeout.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setCveUrl12Base(java.lang.String)">setCveUrl12Base</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cveUrl12Base)</code>
<div class="block">Set the value of cveUrl12Base.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setCveUrl12Modified(java.lang.String)">setCveUrl12Modified</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cveUrl12Modified)</code>
<div class="block">Set the value of cveUrl12Modified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setCveUrl20Base(java.lang.String)">setCveUrl20Base</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cveUrl20Base)</code>
<div class="block">Set the value of cveUrl20Base.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setCveUrl20Modified(java.lang.String)">setCveUrl20Modified</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cveUrl20Modified)</code>
<div class="block">Set the value of cveUrl20Modified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setDatabaseDriverName(java.lang.String)">setDatabaseDriverName</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;databaseDriverName)</code>
<div class="block">Set the value of databaseDriverName.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setDatabaseDriverPath(java.lang.String)">setDatabaseDriverPath</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;databaseDriverPath)</code>
<div class="block">Set the value of databaseDriverPath.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setDatabasePassword(java.lang.String)">setDatabasePassword</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;databasePassword)</code>
<div class="block">Set the value of databasePassword.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setDatabaseUser(java.lang.String)">setDatabaseUser</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;databaseUser)</code>
<div class="block">Set the value of databaseUser.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setDataDirectory(java.lang.String)">setDataDirectory</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dataDirectory)</code>
<div class="block">Set the value of dataDirectory.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setFailBuildOnCVSS(float)">setFailBuildOnCVSS</a></strong>(float&nbsp;failBuildOnCVSS)</code>
<div class="block">Set the value of failBuildOnCVSS.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setJarAnalyzerEnabled(boolean)">setJarAnalyzerEnabled</a></strong>(boolean&nbsp;jarAnalyzerEnabled)</code>
<div class="block">Sets whether or not the analyzer is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setLogFile(java.lang.String)">setLogFile</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;logFile)</code>
<div class="block">Set the value of logFile.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setNexusAnalyzerEnabled(boolean)">setNexusAnalyzerEnabled</a></strong>(boolean&nbsp;nexusAnalyzerEnabled)</code>
<div class="block">Set the value of nexusAnalyzerEnabled.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setNexusUrl(java.lang.String)">setNexusUrl</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nexusUrl)</code>
<div class="block">Set the value of nexusUrl.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setNexusUsesProxy(boolean)">setNexusUsesProxy</a></strong>(boolean&nbsp;nexusUsesProxy)</code>
<div class="block">Set the value of nexusUsesProxy.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setNuspecAnalyzerEnabled(boolean)">setNuspecAnalyzerEnabled</a></strong>(boolean&nbsp;nuspecAnalyzerEnabled)</code>
<div class="block">Sets whether or not the analyzer is enabled.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setPathToMono(java.lang.String)">setPathToMono</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pathToMono)</code>
<div class="block">Set the value of pathToMono.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setProxyPassword(java.lang.String)">setProxyPassword</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;proxyPassword)</code>
<div class="block">Set the value of proxyPassword.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setProxyPort(java.lang.String)">setProxyPort</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;proxyPort)</code>
<div class="block">Set the value of proxyPort.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setProxyServer(java.lang.String)">setProxyServer</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;server)</code>
<div class="block">Set the value of proxyServer.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setProxyUrl(java.lang.String)">setProxyUrl</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;proxyUrl)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
@@ -587,42 +593,48 @@ extends org.apache.tools.ant.Task</pre>
</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setProxyUsername(java.lang.String)">setProxyUsername</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;proxyUsername)</code>
<div class="block">Set the value of proxyUsername.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</a></strong>(org.apache.tools.ant.types.Reference&nbsp;r)</code>
<div class="block">Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setReportFormat(org.owasp.dependencycheck.taskdefs.DependencyCheckTask.ReportFormats)">setReportFormat</a></strong>(<a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.ReportFormats.html" title="class in org.owasp.dependencycheck.taskdefs">DependencyCheckTask.ReportFormats</a>&nbsp;reportFormat)</code>
<div class="block">Set the value of reportFormat.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setReportOutputDirectory(java.lang.String)">setReportOutputDirectory</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;reportOutputDirectory)</code>
<div class="block">Set the value of reportOutputDirectory.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setShowSummary(boolean)">setShowSummary</a></strong>(boolean&nbsp;showSummary)</code>
<div class="block">Set the value of showSummary.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setSuppressionFile(java.lang.String)">setSuppressionFile</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;suppressionFile)</code>
<div class="block">Set the value of suppressionFile.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setUpdateOnly(boolean)">setUpdateOnly</a></strong>(boolean&nbsp;updateOnly)</code>
<div class="block">Set the value of updateOnly</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/taskdefs/DependencyCheckTask.html#setZipExtensions(java.lang.String)">setZipExtensions</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;zipExtensions)</code>
@@ -827,6 +839,28 @@ extends org.apache.tools.ant.Task</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>autoUpdate</code> - new value of autoUpdate</dd></dl>
</li>
</ul>
<a name="isUpdateOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpdateOnly</h4>
<pre>public&nbsp;boolean&nbsp;isUpdateOnly()</pre>
<div class="block">Get the value of updateOnly</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of updateOnly</dd></dl>
</li>
</ul>
<a name="setUpdateOnly(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpdateOnly</h4>
<pre>public&nbsp;void&nbsp;setUpdateOnly(boolean&nbsp;updateOnly)</pre>
<div class="block">Set the value of updateOnly</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>updateOnly</code> - new value of updateOnly</dd></dl>
</li>
</ul>
<a name="getReportFormat()">
<!-- -->
</a>