org.owasp.dependencycheck.utils

Class Downloader

java.lang.Object

org.owasp.dependencycheck.utils.Downloader

public final class Downloader
extends java.lang.Object

A utility to download files from the Internet.

Version:

$Id: $Id

Author:

Jeremy Long

Constructor Summary

Constructors

Constructor and Description
Downloader(Settings settings) Constructs a new Downloader object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	fetchContent(java.net.URL url, boolean useProxy) Retrieves a file from a given URL and returns the contents.
java.lang.String	fetchContent(java.net.URL url, boolean useProxy, java.lang.String userKey, java.lang.String passwordKey) Retrieves a file from a given URL and returns the contents.
void	fetchFile(java.net.URL url, java.io.File outputPath) Retrieves a file from a given URL and saves it to the outputPath.
void	fetchFile(java.net.URL url, java.io.File outputPath, boolean useProxy) Retrieves a file from a given URL and saves it to the outputPath.
void	fetchFile(java.net.URL url, java.io.File outputPath, boolean useProxy, java.lang.String userKey, java.lang.String passwordKey) Retrieves a file from a given URL and saves it to the outputPath.
void	fetchFile(java.net.URL url, java.io.File outputPath, java.lang.String userKey, java.lang.String passwordKey) Retrieves a file from a given URL and saves it to the outputPath.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Downloader

public Downloader(Settings settings)

Constructs a new Downloader object.

Parameters:

settings - the configured settings

Method Detail

fetchFile

public void fetchFile(java.net.URL url,
                      java.io.File outputPath)
               throws DownloadFailedException,
                      TooManyRequestsException,
                      ResourceNotFoundException

Retrieves a file from a given URL and saves it to the outputPath.

Parameters:

url - the URL of the file to download

outputPath - the path to the save the file to

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

fetchFile

public void fetchFile(java.net.URL url,
                      java.io.File outputPath,
                      java.lang.String userKey,
                      java.lang.String passwordKey)
               throws DownloadFailedException,
                      TooManyRequestsException,
                      ResourceNotFoundException

Retrieves a file from a given URL and saves it to the outputPath.

Parameters:

url - the URL of the file to download

outputPath - the path to the save the file to

userKey - the settings key for the username to be used

passwordKey - the settings key for the password to be used

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

fetchFile

public void fetchFile(java.net.URL url,
                      java.io.File outputPath,
                      boolean useProxy)
               throws DownloadFailedException,
                      TooManyRequestsException,
                      ResourceNotFoundException

Retrieves a file from a given URL and saves it to the outputPath.

Parameters:

url - the URL of the file to download

outputPath - the path to the save the file to

useProxy - whether to use the configured proxy when downloading files

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

fetchFile

public void fetchFile(java.net.URL url,
                      java.io.File outputPath,
                      boolean useProxy,
                      java.lang.String userKey,
                      java.lang.String passwordKey)
               throws DownloadFailedException,
                      TooManyRequestsException,
                      ResourceNotFoundException

Retrieves a file from a given URL and saves it to the outputPath.

Parameters:

url - the URL of the file to download

outputPath - the path to the save the file to

useProxy - whether to use the configured proxy when downloading files

userKey - the settings key for the username to be used

passwordKey - the settings key for the password to be used

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

fetchContent

public java.lang.String fetchContent(java.net.URL url,
                                     boolean useProxy)
                              throws DownloadFailedException,
                                     TooManyRequestsException,
                                     ResourceNotFoundException

Retrieves a file from a given URL and returns the contents.

Parameters:

url - the URL of the file to download

useProxy - whether to use the configured proxy when downloading files

Returns:

the content of the file

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

fetchContent

public java.lang.String fetchContent(java.net.URL url,
                                     boolean useProxy,
                                     java.lang.String userKey,
                                     java.lang.String passwordKey)
                              throws DownloadFailedException,
                                     TooManyRequestsException,
                                     ResourceNotFoundException

Retrieves a file from a given URL and returns the contents.

Parameters:

url - the URL of the file to download

useProxy - whether to use the configured proxy when downloading files

userKey - the settings key for the username to be used

passwordKey - the settings key for the password to be used

Returns:

the content of the file

Throws:

DownloadFailedException - is thrown if there is an error downloading the file

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received