documentation version 1.4.2

This commit is contained in:
Jeremy Long
2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions

View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 16 06:44:12 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Sun Jul 31 07:37:31 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Downloader (Dependency-Check Utils 1.4.0 API)</title>
<meta name="date" content="2016-06-16">
<title>Downloader (Dependency-Check Utils 1.4.2 API)</title>
<meta name="date" content="2016-07-31">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -13,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Downloader (Dependency-Check Utils 1.4.0 API)";
parent.document.title="Downloader (Dependency-Check Utils 1.4.2 API)";
}
}
catch(err) {
@@ -136,9 +136,10 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#analyzeException-java.io.IOException-">analyzeException</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;ex)</code>
<div class="block">Analyzes the IOException, logs the appropriate information for debugging purposes, and then throws a
DownloadFailedException that wraps the IO Exception.</div>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#checkForCommonExceptionTypes-java.io.IOException-">checkForCommonExceptionTypes</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;ex)</code>
<div class="block">Analyzes the IOException, logs the appropriate information for debugging
purposes, and then throws a DownloadFailedException that wraps the IO
Exception for common IO Exceptions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
@@ -159,7 +160,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#getLastModified-java.net.URL-">getLastModified</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>&nbsp;url)</code>
<div class="block">Makes an HTTP Head request to retrieve the last modified date of the given URL.</div>
<div class="block">Makes an HTTP Head request to retrieve the last modified date of the
given URL.</div>
</td>
</tr>
</table>
@@ -199,7 +201,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dd><code>url</code> - the URL of the file to download</dd>
<dd><code>outputPath</code> - the path to the save the file to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if there is an error downloading the file</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if there is an error
downloading the file</dd>
</dl>
</li>
</ul>
@@ -218,9 +221,11 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - the URL of the file to download</dd>
<dd><code>outputPath</code> - the path to the save the file to</dd>
<dd><code>useProxy</code> - whether to use the configured proxy when downloading files</dd>
<dd><code>useProxy</code> - whether to use the configured proxy when downloading
files</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if there is an error downloading the file</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if there is an error
downloading the file</dd>
</dl>
</li>
</ul>
@@ -232,33 +237,38 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getLastModified</h4>
<pre>public static&nbsp;long&nbsp;getLastModified(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>&nbsp;url)
throws <a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></pre>
<div class="block">Makes an HTTP Head request to retrieve the last modified date of the given URL. If the file:// protocol is specified, then
the lastTimestamp of the file is returned.</div>
<div class="block">Makes an HTTP Head request to retrieve the last modified date of the
given URL. If the file:// protocol is specified, then the lastTimestamp
of the file is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - the URL to retrieve the timestamp from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an epoch timestamp</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if an exception occurs making the HTTP request</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - is thrown if an exception occurs making
the HTTP request</dd>
</dl>
</li>
</ul>
<a name="analyzeException-java.io.IOException-">
<a name="checkForCommonExceptionTypes-java.io.IOException-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>analyzeException</h4>
<pre>protected static&nbsp;void&nbsp;analyzeException(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;ex)
throws <a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></pre>
<div class="block">Analyzes the IOException, logs the appropriate information for debugging purposes, and then throws a
DownloadFailedException that wraps the IO Exception.</div>
<h4>checkForCommonExceptionTypes</h4>
<pre>protected static&nbsp;void&nbsp;checkForCommonExceptionTypes(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;ex)
throws <a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></pre>
<div class="block">Analyzes the IOException, logs the appropriate information for debugging
purposes, and then throws a DownloadFailedException that wraps the IO
Exception for common IO Exceptions. This is to provide additional details
to assist in resolution of the exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - the original exception</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - a wrapper exception that contains the original exception as the cause</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></code> - a wrapper exception that contains the
original exception as the cause</dd>
</dl>
</li>
</ul>