Class GetURL

java.lang.Object

org.deltava.dao.http.DAO

org.deltava.dao.http.GetURL

public class GetURL
extends DAO

A Data Access Object to download a file via HTTP.

Since:

5.0

Version:

11.6

Author:

Luke

Constructor Summary

Constructors

Constructor	Description
GetURL(String url, String fileName)	Initializes the Data Access Object

Method Summary

Modifier and Type	Method	Description
File	download()	Downloads the file.
int	getStatusCode()	Returns the HTTP status code for this request.
boolean	isAvailable()	Checks whether the URL is available for download.
byte[]	load()	Loads a URL into a buffer.
void	setForce(boolean doForce)	Forces file download even if the remote resource has not changed.
void	setIfModifiedSince(Instant dt)	Updates the timestamp used to send an If-Modified-Since header.

Methods inherited from class DAO

getCompression, getHeaderField, getIn, getOut, getResponseCode, init, reset, setAuthentication, setCompression, setConnectTimeout, setMethod, setReadTimeout, setRequestHeader, setReturnErrorStream

Modifier and Type	Method	Description
Compression	getCompression()	Returns the response compression type.
protected String	getHeaderField(String name)	Returns an HTTP response header.
protected InputStream	getIn()	Retrieves an input stream to the URL.
protected OutputStream	getOut()	Retrieves an output stream to the URL.
protected int	getResponseCode()	Returns the HTTP response code for this request.
protected void	init(String url)	Helper method to open the connection.
void	reset()	Resets the connection for subsequent reuse.
protected void	setAuthentication(String userID, String pwd)	Sets an authentication request header.
void	setCompression(Compression... cmps)	Updates the allowed compression for this request.
void	setConnectTimeout(int timeout)	Sets the HTTP connect timeout.
void	setMethod(String method)	Sets the HTTP method to use if not GET.
void	setReadTimeout(int timeout)	Sets the HTTP connect timeout.
protected void	setRequestHeader(String name, String value)	Sets a request header.
void	setReturnErrorStream(boolean returnErrStream)	Sets whether the error stream should be returned when connecting and an error occurs.

Methods inherited from class Object

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

Constructor Details

GetURL

public GetURL(String url,
 String fileName)

Initializes the Data Access Object

Parameters:

url - the URL to download from

fileName - the file to save the contents to

Method Details

getStatusCode

public int getStatusCode()

Returns the HTTP status code for this request.

Returns:

the HTTP status code

setForce

public void setForce(boolean doForce)

Forces file download even if the remote resource has not changed.

Parameters:

doForce - TRUE if download is forced, otherwise FALSE

setIfModifiedSince

public void setIfModifiedSince(Instant dt)

Updates the timestamp used to send an If-Modified-Since header.

Parameters:

dt - the date/time

download

public File download()
              throws DAOException

Downloads the file.

Returns:

TRUE if a new copy was downloaded, otherwise FALSE

Throws:

DAOException - if an error occurs

load

public byte[] load()
            throws DAOException

Loads a URL into a buffer.

Returns:

the buffer

Throws:

DAOException - if an error occurs

isAvailable

public boolean isAvailable()
                    throws DAOException

Checks whether the URL is available for download.

Returns:

TRUE if content is available, otherwise FALSE

Throws:

DAOException - if an unexpected error occurs