net.covers1624.quack.gradle.net.download

Class ApacheHttpClientDownloadTask

java.lang.Object

DefaultTask

net.covers1624.quack.gradle.net.download.ApacheHttpClientDownloadTask

All Implemented Interfaces:

DownloadAction

public class ApacheHttpClientDownloadTask
extends DefaultTask
implements DownloadAction

A Gradle task for a ApacheHttpClientDownloadAction.

Created by covers1624 on 22/11/21.

Nested Class Summary

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

DownloadAction.Dest

Constructor Summary

Constructors

Constructor and Description
ApacheHttpClientDownloadTask()

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.
CloseableHttpClient	getClient()
DownloadAction.Dest	getDest()
DownloadListener	getDownloadListener()
boolean	getOnlyIfModified()
boolean	getQuiet()
java.lang.String	getUrl()
boolean	getUseETag()
java.lang.String	getUserAgent()
boolean	isUpToDate()
ApacheHttpClientDownloadTask	setClient(CloseableHttpClient client)
ApacheHttpClientDownloadTask	setDest(DownloadAction.Dest dest) Set the Destination to download content to.
ApacheHttpClientDownloadTask	setDest(java.io.File file) Set the File to download content to.
ApacheHttpClientDownloadTask	setDest(java.io.OutputStream os) Set the OutputStream to download content to.
ApacheHttpClientDownloadTask	setDest(java.nio.file.Path path) Set the Path to download content to.
ApacheHttpClientDownloadTask	setDest(java.io.StringWriter sw) Set the StringWriter to download content to.
ApacheHttpClientDownloadTask	setDownloadListener(DownloadListener downloadListener) Set the DownloadListener to use.
ApacheHttpClientDownloadTask	setOnlyIfModified(boolean onlyIfModified) If this Download action should use If-Modified-Since HTTP request header.
ApacheHttpClientDownloadTask	setQuiet(boolean quiet) If this download action should not log things.
ApacheHttpClientDownloadTask	setUrl(java.lang.String url) Set the URL to download from.
ApacheHttpClientDownloadTask	setUseETag(boolean useETag) If this download action should use If-None-Match HTTP request header.
ApacheHttpClientDownloadTask	setUserAgent(java.lang.String userAgent) Sets the User-Agent HTTP request header.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheHttpClientDownloadTask

public ApacheHttpClientDownloadTask()

Method Detail

execute

public void execute()
             throws java.io.IOException

Description copied from interface: DownloadAction

Execute the download action.

Specified by:

execute in interface DownloadAction

Throws:

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

HttpResponseException - If the response code was not expected.

setClient

public ApacheHttpClientDownloadTask setClient(CloseableHttpClient client)

setUrl

public ApacheHttpClientDownloadTask setUrl(java.lang.String url)

Description copied from interface: DownloadAction

Set the URL to download from.

Specified by:

setUrl in interface DownloadAction

Parameters:

url - The URL.

Returns:

The same download action.

setDest

public ApacheHttpClientDownloadTask setDest(DownloadAction.Dest dest)

Description copied from interface: DownloadAction

Set the Destination to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

dest - The Destination.

Returns:

The same download action.

setDest

public ApacheHttpClientDownloadTask setDest(java.io.StringWriter sw)

Description copied from interface: DownloadAction

Set the StringWriter to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

sw - The StringWriter.

Returns:

The same download action.

setDest

public ApacheHttpClientDownloadTask setDest(java.io.OutputStream os)

Description copied from interface: DownloadAction

Set the OutputStream to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

os - The OutputStream.

Returns:

The same download action.

setDest

public ApacheHttpClientDownloadTask setDest(java.io.File file)

Description copied from interface: DownloadAction

Set the File to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

file - The file.

Returns:

The same download action.

setDest

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

Description copied from interface: DownloadAction

Set the Path to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

path - The path.

Returns:

The same download action.

setOnlyIfModified

public ApacheHttpClientDownloadTask 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

Parameters:

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

Returns:

The same download action.

setUseETag

public ApacheHttpClientDownloadTask 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

Parameters:

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

Returns:

The same download action.

setQuiet

public ApacheHttpClientDownloadTask setQuiet(boolean quiet)

Description copied from interface: DownloadAction

If this download action should not log things.

Specified by:

setQuiet in interface DownloadAction

Parameters:

quiet - If the download action should be quiet.

Returns:

The same download action.

setUserAgent

public ApacheHttpClientDownloadTask setUserAgent(java.lang.String userAgent)

Description copied from interface: DownloadAction

Sets the User-Agent HTTP request header.

Specified by:

setUserAgent in interface DownloadAction

Parameters:

userAgent - The User-Agent request header.

Returns:

The same download action.

addRequestHeader

public DownloadAction 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

Parameters:

key - The key.

value - The value.

Returns:

The same download action.

setDownloadListener

public ApacheHttpClientDownloadTask setDownloadListener(DownloadListener downloadListener)

Description copied from interface: DownloadAction

Set the DownloadListener to use.

Specified by:

setDownloadListener in interface DownloadAction

Parameters:

downloadListener - The DownloadListener.

Returns:

The same download action.

getClient

public CloseableHttpClient getClient()

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface DownloadAction

getDest

public DownloadAction.Dest getDest()

Specified by:

getDest in interface DownloadAction

getOnlyIfModified

public boolean getOnlyIfModified()

Specified by:

getOnlyIfModified in interface DownloadAction

getUseETag

public boolean getUseETag()

Specified by:

getUseETag in interface DownloadAction

getQuiet

public boolean getQuiet()

Specified by:

getQuiet in interface DownloadAction

getUserAgent

public java.lang.String getUserAgent()

Specified by:

getUserAgent in interface DownloadAction

getDownloadListener

public DownloadListener getDownloadListener()

Specified by:

getDownloadListener in interface DownloadAction

isUpToDate

public boolean isUpToDate()

Specified by:

isUpToDate in interface DownloadAction