net.covers1624.quack.net

Class HttpEngineDownloadAction

java.lang.Object

net.covers1624.quack.net.AbstractDownloadAction

net.covers1624.quack.net.HttpEngineDownloadAction

All Implemented Interfaces:

DownloadAction

public class HttpEngineDownloadAction
extends AbstractDownloadAction

A DownloadAction backed by the HttpEngine abstraction.

Created by covers1624 on 16/7/24.

Nested Class Summary

Nested classes/interfaces inherited from interface net.covers1624.quack.net.DownloadAction

DownloadAction.Dest

Field Summary

Fields inherited from class net.covers1624.quack.net.AbstractDownloadAction

dest, downloadListener, headerList, headers, onlyIfModified, quiet, upToDate, url, useETag, userAgent

Constructor Summary

Constructors

Constructor and Description
HttpEngineDownloadAction()
HttpEngineDownloadAction(HttpEngine engine)

Method Summary

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

Methods inherited from class net.covers1624.quack.net.AbstractDownloadAction

calcUpToDate, expectNotModified, getDest, getDownloadListener, getOnlyIfModified, getQuiet, getUrl, getUseETag, getUserAgent, isUpToDate, validateCode

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEngineDownloadAction

public HttpEngineDownloadAction()

HttpEngineDownloadAction

public HttpEngineDownloadAction(HttpEngine engine)

Method Detail

execute

public void execute()
             throws java.io.IOException

Description copied from interface: DownloadAction

Execute the download action.

Throws:

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

HttpResponseException - If the response code was not expected.

setEngine

public HttpEngineDownloadAction setEngine(HttpEngine engine)

setUrl

public HttpEngineDownloadAction setUrl(java.lang.String url)

Description copied from interface: DownloadAction

Set the URL to download from.

Specified by:

setUrl in interface DownloadAction

Overrides:

setUrl in class AbstractDownloadAction

Parameters:

url - The URL.

Returns:

The same download action.

setDest

public HttpEngineDownloadAction setDest(DownloadAction.Dest dest)

Description copied from interface: DownloadAction

Set the Destination to download content to.

Specified by:

setDest in interface DownloadAction

Overrides:

setDest in class AbstractDownloadAction

Parameters:

dest - The Destination.

Returns:

The same download action.

setDest

public HttpEngineDownloadAction setDest(java.io.StringWriter sw)

Description copied from interface: DownloadAction

Set the StringWriter to download content to.

Specified by:

setDest in interface DownloadAction

Overrides:

setDest in class AbstractDownloadAction

Parameters:

sw - The StringWriter.

Returns:

The same download action.

setDest

public HttpEngineDownloadAction setDest(java.io.OutputStream os)

Description copied from interface: DownloadAction

Set the OutputStream to download content to.

Specified by:

setDest in interface DownloadAction

Overrides:

setDest in class AbstractDownloadAction

Parameters:

os - The OutputStream.

Returns:

The same download action.

setDest

public HttpEngineDownloadAction setDest(java.io.File file)

Description copied from interface: DownloadAction

Set the File to download content to.

Specified by:

setDest in interface DownloadAction

Overrides:

setDest in class AbstractDownloadAction

Parameters:

file - The file.

Returns:

The same download action.

setDest

public HttpEngineDownloadAction setDest(java.nio.file.Path path)

Description copied from interface: DownloadAction

Set the Path to download content to.

Specified by:

setDest in interface DownloadAction

Overrides:

setDest in class AbstractDownloadAction

Parameters:

path - The path.

Returns:

The same download action.

setOnlyIfModified

public HttpEngineDownloadAction setOnlyIfModified(boolean onlyIfModified)

Description copied from interface: DownloadAction

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

Specified by:

setOnlyIfModified in interface DownloadAction

Overrides:

setOnlyIfModified in class AbstractDownloadAction

Parameters:

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

Returns:

The same download action.

setUseETag

public HttpEngineDownloadAction setUseETag(boolean useETag)

Description copied from interface: DownloadAction

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

Specified by:

setUseETag in interface DownloadAction

Overrides:

setUseETag in class AbstractDownloadAction

Parameters:

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

Returns:

The same download action.

setQuiet

public HttpEngineDownloadAction setQuiet(boolean quiet)

Description copied from interface: DownloadAction

If this download action should not log things.

Specified by:

setQuiet in interface DownloadAction

Overrides:

setQuiet in class AbstractDownloadAction

Parameters:

quiet - If the download action should be quiet.

Returns:

The same download action.

addRequestHeader

public HttpEngineDownloadAction addRequestHeader(java.lang.String key,
                                                 java.lang.String value)

Description copied from interface: DownloadAction

Adds an arbitrary Http header to the action.

Specified by:

addRequestHeader in interface DownloadAction

Overrides:

addRequestHeader in class AbstractDownloadAction

Parameters:

key - The key.

value - The value.

Returns:

The same download action.

setUserAgent

public HttpEngineDownloadAction setUserAgent(java.lang.String userAgent)

Description copied from interface: DownloadAction

Sets the User-Agent HTTP request header.

Specified by:

setUserAgent in interface DownloadAction

Overrides:

setUserAgent in class AbstractDownloadAction

Parameters:

userAgent - The User-Agent request header.

Returns:

The same download action.

setDownloadListener

public HttpEngineDownloadAction setDownloadListener(DownloadListener downloadListener)

Description copied from interface: DownloadAction

Set the DownloadListener to use.

Specified by:

setDownloadListener in interface DownloadAction

Overrides:

setDownloadListener in class AbstractDownloadAction

Parameters:

downloadListener - The DownloadListener.

Returns:

The same download action.