net.covers1624.quack.net

Interface DownloadAction

All Known Implementing Classes:

AbstractDownloadAction, ApacheHttpClientDownloadAction, ApacheHttpClientDownloadTask, JavaDownloadAction, OkHttpDownloadAction

public interface DownloadAction

A simple action to download a single file.

Download Actions support ETag and OnlyIfModified Http headers. As well as downloading the file to an in-memory String/byte array.

Several implementations of this exist: Java HttpURLConnection: JavaDownloadAction. OkHttp: OkHttpDownloadAction. Apache HttpClient: ApacheHttpClientDownloadAction.

Created by covers1624 on 22/11/21.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DownloadAction.Dest Interface for consuming the output of an HTTP response.

Method Summary

Modifier and Type	Method and Description
DownloadAction	addRequestHeader(java.lang.String key, java.lang.String value) Adds an arbitrary Http header to the action.
void	execute() Execute the download action.
DownloadAction.Dest	getDest()
DownloadListener	getDownloadListener()
boolean	getOnlyIfModified()
boolean	getQuiet()
java.lang.String	getUrl()
boolean	getUseETag()
java.lang.String	getUserAgent()
boolean	isUpToDate()
DownloadAction	setDest(DownloadAction.Dest dest) Set the Destination to download content to.
DownloadAction	setDest(java.io.File file) Set the File to download content to.
DownloadAction	setDest(java.io.OutputStream os) Set the OutputStream to download content to.
DownloadAction	setDest(java.nio.file.Path path) Set the Path to download content to.
DownloadAction	setDest(java.io.StringWriter sw) Set the StringWriter to download content to.
DownloadAction	setDownloadListener(DownloadListener downloadListener) Set the DownloadListener to use.
DownloadAction	setOnlyIfModified(boolean onlyIfModified) If this Download action should use If-Modified-Since HTTP request header.
DownloadAction	setQuiet(boolean quiet) If this download action should not log things.
DownloadAction	setUrl(java.lang.String url) Set the URL to download from.
DownloadAction	setUseETag(boolean useETag) If this download action should use If-None-Match HTTP request header.
DownloadAction	setUserAgent(java.lang.String userAgent) Sets the User-Agent HTTP request header.

Method Detail

execute

void execute()
      throws java.io.IOException

Execute the download action.

Throws:

java.io.IOException - If an IO error occurs whilst downloading.

HttpResponseException - If the response code was not expected.

setUrl

DownloadAction setUrl(java.lang.String url)

Set the URL to download from.

Parameters:

url - The URL.

Returns:

The same download action.

setDest

DownloadAction setDest(DownloadAction.Dest dest)

Set the Destination to download content to.

Parameters:

dest - The Destination.

Returns:

The same download action.

setDest

DownloadAction setDest(java.io.StringWriter sw)

Set the StringWriter to download content to.

Parameters:

sw - The StringWriter.

Returns:

The same download action.

setDest

DownloadAction setDest(java.io.OutputStream os)

Set the OutputStream to download content to.

Parameters:

os - The OutputStream.

Returns:

The same download action.

setDest

DownloadAction setDest(java.io.File file)

Set the File to download content to.

Parameters:

file - The file.

Returns:

The same download action.

setDest

DownloadAction setDest(java.nio.file.Path path)

Set the Path to download content to.

Parameters:

path - The path.

Returns:

The same download action.

setOnlyIfModified

DownloadAction setOnlyIfModified(boolean onlyIfModified)

If this Download action should use If-Modified-Since HTTP request header.

Parameters:

onlyIfModified - If If-Modified-Since should be used.

Returns:

The same download action.

setUseETag

DownloadAction setUseETag(boolean useETag)

If this download action should use If-None-Match HTTP request header.

Parameters:

useETag - If If-None-Match should be used.

Returns:

The same download action.

setQuiet

DownloadAction setQuiet(boolean quiet)

If this download action should not log things.

Parameters:

quiet - If the download action should be quiet.

Returns:

The same download action.

setUserAgent

DownloadAction setUserAgent(java.lang.String userAgent)

Sets the User-Agent HTTP request header.

Parameters:

userAgent - The User-Agent request header.

Returns:

The same download action.

addRequestHeader

DownloadAction addRequestHeader(java.lang.String key,
                                java.lang.String value)

Adds an arbitrary Http header to the action.

Parameters:

key - The key.

value - The value.

Returns:

The same download action.

setDownloadListener

DownloadAction setDownloadListener(DownloadListener downloadListener)

Set the DownloadListener to use.

Parameters:

downloadListener - The DownloadListener.

Returns:

The same download action.

getUrl

java.lang.String getUrl()

getDest

DownloadAction.Dest getDest()

getOnlyIfModified

boolean getOnlyIfModified()

getUseETag

boolean getUseETag()

getQuiet

boolean getQuiet()

getUserAgent

java.lang.String getUserAgent()

getDownloadListener

DownloadListener getDownloadListener()

isUpToDate

boolean isUpToDate()