org.owasp.dependencycheck.utils

Class HttpResourceConnection

java.lang.Object

org.owasp.dependencycheck.utils.HttpResourceConnection

All Implemented Interfaces:

java.lang.AutoCloseable

public class HttpResourceConnection
extends java.lang.Object
implements java.lang.AutoCloseable

A utility to download files from the Internet.

Version:

$Id: $Id

Author:

Jeremy Long

Constructor Summary

Constructors

Constructor and Description
HttpResourceConnection(Settings settings) Constructs a new HttpResourceConnection object.
HttpResourceConnection(Settings settings, boolean usesProxy) Constructs a new HttpResourceConnection object.
HttpResourceConnection(Settings settings, boolean usesProxy, java.lang.String userKey, java.lang.String passwordKey) Constructs a new HttpResourceConnection object.

Method Summary

Modifier and Type	Method and Description
void	checkForCommonExceptionTypes(java.io.IOException ex) Analyzes the IOException, logs the appropriate information for debugging purposes, and then throws a DownloadFailedException that wraps the IO Exception for common IO Exceptions.
void	close()
java.io.InputStream	fetch(java.net.URL url) Retrieves the resource identified by the given URL and returns the InputStream.
boolean	isClosed() Returns whether or not the connection has been closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResourceConnection

public HttpResourceConnection(Settings settings)

Constructs a new HttpResourceConnection object.

Parameters:

settings - the configured settings

HttpResourceConnection

public HttpResourceConnection(Settings settings,
                              boolean usesProxy)

Constructs a new HttpResourceConnection object.

Parameters:

settings - the configured settings

usesProxy - control whether this conn will use the defined proxy.

HttpResourceConnection

public HttpResourceConnection(Settings settings,
                              boolean usesProxy,
                              java.lang.String userKey,
                              java.lang.String passwordKey)

Constructs a new HttpResourceConnection object.

Parameters:

settings - the configured settings

usesProxy - control whether this conn will use the defined proxy

userKey - the settings key for the username to be used

passwordKey - the settings key for the password to be used

Method Detail

fetch

public java.io.InputStream fetch(java.net.URL url)
                          throws DownloadFailedException,
                                 TooManyRequestsException,
                                 ResourceNotFoundException

Retrieves the resource identified by the given URL and returns the InputStream.

Parameters:

url - the URL of the resource to download

Returns:

the stream to read the retrieved content from

Throws:

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

TooManyRequestsException - thrown when a 429 is received

ResourceNotFoundException - thrown when a 404 is received

close

public void close()

Releases the underlying HTTP URL Connection.

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()

Returns whether or not the connection has been closed.

Returns:

whether or not the connection has been closed

checkForCommonExceptionTypes

public void checkForCommonExceptionTypes(java.io.IOException ex)
                                  throws DownloadFailedException

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.

Parameters:

ex - the original exception

Throws:

DownloadFailedException - a wrapper exception that contains the original exception as the cause