net.covers1624.quack.net.okhttp

Class OkHttpDownloadAction

java.lang.Object

net.covers1624.quack.net.okhttp.OkHttpDownloadAction

All Implemented Interfaces:

DownloadAction

public class OkHttpDownloadAction
extends java.lang.Object
implements DownloadAction

An OkHttp implementation of DownloadAction.

Created by covers1624 on 20/11/21.

Nested Class Summary

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

DownloadAction.Dest

Constructor Summary

Constructors

Constructor and Description
OkHttpDownloadAction()

Method Summary

Modifier and Type	Method and Description
OkHttpDownloadAction	addTag(java.lang.Class<?> clazz, java.lang.Object tag) Add a Tag to the OkHttp Request.
void	execute() Execute the download action.
OkHttpClient	getClient()
DownloadAction.Dest	getDest()
DownloadListener	getDownloadListener()
boolean	getOnlyIfModified()
boolean	getQuiet()
java.util.Map<java.lang.Class<?>,java.lang.Object>	getTags()
java.lang.String	getUrl()
boolean	getUseETag()
java.lang.String	getUserAgent()
boolean	isUpToDate()
OkHttpDownloadAction	setClient(OkHttpClient client) Set the OkHttpClient client to use.
OkHttpDownloadAction	setDest(DownloadAction.Dest dest) Set the Destination to download content to.
OkHttpDownloadAction	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.
OkHttpDownloadAction	setDest(java.nio.file.Path path) Set the Path to download content to.
OkHttpDownloadAction	setDest(java.io.StringWriter sw) Set the StringWriter to download content to.
OkHttpDownloadAction	setDownloadListener(DownloadListener downloadListener) Set the DownloadListener to use.
OkHttpDownloadAction	setOnlyIfModified(boolean onlyIfModified) If this Download action should use If-Modified-Since HTTP request header.
OkHttpDownloadAction	setQuiet(boolean quiet) If this download action should not log things.
OkHttpDownloadAction	setUrl(java.lang.String url) Set the URL to download from.
OkHttpDownloadAction	setUseETag(boolean useETag) If this download action should use If-None-Match HTTP request header.
OkHttpDownloadAction	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

OkHttpDownloadAction

public OkHttpDownloadAction()

Method Detail

execute

public void execute()
             throws java.io.IOException

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 OkHttpDownloadAction setClient(OkHttpClient client)

Set the OkHttpClient client to use.

Parameters:

client - The OkHttpClient.

Returns:

The same download action.

setUrl

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

setDownloadListener

public OkHttpDownloadAction 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.

addTag

public OkHttpDownloadAction addTag(java.lang.Class<?> clazz,
                                   java.lang.Object tag)

Add a Tag to the OkHttp Request.

Parameters:

clazz - The Tag type.

tag - The tag.

Returns:

The same download action.

isUpToDate

public boolean isUpToDate()

Specified by:

isUpToDate in interface DownloadAction

getClient

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

getTags

public java.util.Map<java.lang.Class<?>,java.lang.Object> getTags()