mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-02-24 19:35:16 +01:00
305 lines
16 KiB
HTML
305 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_71) on Fri Mar 06 06:02:08 EST 2015 -->
|
|
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
|
|
<title>Downloader (Dependency-Check Utils 1.2.9 API)</title>
|
|
<meta name="date" content="2015-03-06">
|
|
<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="Downloader (Dependency-Check Utils 1.2.9 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Downloader.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/utils/Downloader.html" target="_top">Frames</a></li>
|
|
<li><a href="Downloader.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.owasp.dependencycheck.utils</div>
|
|
<h2 title="Class Downloader" class="title">Class Downloader</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.owasp.dependencycheck.utils.Downloader</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public final class <span class="strong">Downloader</span>
|
|
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
|
|
<div class="block">A utility to download files from the Internet.</div>
|
|
<dl><dt><span class="strong">Author:</span></dt>
|
|
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#analyzeException(java.io.IOException)">analyzeException</a></strong>(<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> 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>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#fetchFile(java.net.URL,%20java.io.File)">fetchFile</a></strong>(<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> url,
|
|
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputPath)</code>
|
|
<div class="block">Retrieves a file from a given URL and saves it to the outputPath.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#fetchFile(java.net.URL,%20java.io.File,%20boolean)">fetchFile</a></strong>(<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> url,
|
|
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputPath,
|
|
boolean useProxy)</code>
|
|
<div class="block">Retrieves a file from a given URL and saves it to the outputPath.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/Downloader.html#getLastModified(java.net.URL)">getLastModified</a></strong>(<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> url)</code>
|
|
<div class="block">Makes an HTTP Head request to retrieve the last modified date of the given URL.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="fetchFile(java.net.URL, java.io.File)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchFile</h4>
|
|
<pre>public static void fetchFile(<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> url,
|
|
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputPath)
|
|
throws <a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></pre>
|
|
<div class="block">Retrieves a file from a given URL and saves it to the outputPath.</div>
|
|
<dl><dt><span class="strong">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>
|
|
<dt><span class="strong">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></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="fetchFile(java.net.URL, java.io.File, boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fetchFile</h4>
|
|
<pre>public static void fetchFile(<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> url,
|
|
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputPath,
|
|
boolean useProxy)
|
|
throws <a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils">DownloadFailedException</a></pre>
|
|
<div class="block">Retrieves a file from a given URL and saves it to the outputPath.</div>
|
|
<dl><dt><span class="strong">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>
|
|
<dt><span class="strong">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></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLastModified(java.net.URL)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLastModified</h4>
|
|
<pre>public static long 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> 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>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the URL to retrieve the timestamp from</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>an epoch timestamp</dd>
|
|
<dt><span class="strong">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></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="analyzeException(java.io.IOException)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>analyzeException</h4>
|
|
<pre>protected static void 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> 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>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ex</code> - the original exception</dd>
|
|
<dt><span class="strong">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></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Downloader.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/utils/DownloadFailedException.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/utils/Downloader.html" target="_top">Frames</a></li>
|
|
<li><a href="Downloader.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright© 2012-15 Jeremy Long. All Rights Reserved.</small></p>
|
|
</body>
|
|
</html>
|