net.covers1624.quack.gradle.net.download

Class DownloadTask

java.lang.Object

DefaultTask

net.covers1624.quack.gradle.net.download.DownloadTask

All Implemented Interfaces:

DownloadSpec

public class DownloadTask
extends DefaultTask
implements DownloadSpec

Inspired and vaguely based off https://github.com/michel-kraemer/gradle-download-task

 Notable differences:
  Wayyy simpler implementation.
  Lazy evaluation of file and URL inputs.
  Single file downloads.
  External validation of file for up-to-date checking.
  UserAgent spoofing. (Thanks mojang!)
  Ability to set the ProgressLogger to use.
 

This is split into an Action, Spec and Task.

The Spec DownloadSpec, Provides the specification for how things work.

The Action DownloadAction, What actually handles downloading implements DownloadSpec, Useful for other tasks that need to download something but not necessarily create an entire task to do said download.

The Task DownloadTask for gradle, Task wrapper for DownloadAction, implements DownloadSpec and hosts the Action as a task.

Created by covers1624 on 8/02/19.

Constructor Summary

Constructors

Constructor and Description
DownloadTask()

Method Summary

Modifier and Type	Method and Description
void	doTask()
void	fileUpToDateWhen(<any> spec) Spec to validate the already existing file this DownloadSpec will download.
java.nio.file.Path	getDest() Gets the destination file to download to.
java.nio.file.Path	getETagFile() The file to store the ETag in.
DownloadListener	getListener() Gets the currently attached DownloadListener.
boolean	getOnlyIfModified()
java.net.URL	getSrc() Gets the source URL for the file that will be downloaded.
DownloadAction.UseETag	getUseETag()
java.lang.String	getUserAgent() Gets the User-Agent header this DownloadSpec will use for requests.
boolean	isQuiet() If this DownloadSpec is being quiet.
boolean	isUpToDate() To be used after the DownloadSpec has been executed, will return weather the DownloadSpec was up-to-date and no work was performed.
void	setDest(java.io.File dest) Sets the destination to store the downloaded file.
void	setDest(java.nio.file.Path dest) Sets the destination to store the downloaded file.
void	setETagFile(java.io.File eTagFile) Sets the file to store the ETag in.
void	setETagFile(java.nio.file.Path eTagFile) Sets the file to store the ETag in.
void	setListener(DownloadListener listener) Forcibly set the DownloadListener to use for this DownloadSpec.
void	setOnlyIfModified(boolean onlyIfModified) Sets weather this DownloadSpec should obey onlyIfModified HTTP headers.
void	setQuiet(boolean quiet) Sets weather quiet is enabled or not.
void	setSrc(java.lang.Object src) Sets the source URL to download.
void	setUseETag(java.lang.Object useETag) Sets weather this DownloadSpec should use ETags for HTTP requests.
void	setUserAgent(java.lang.String userAgent) Sets the User-Agent HTTP header string to use for HTTP requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadTask

public DownloadTask()

Method Detail

doTask

public void doTask()
            throws java.io.IOException

Throws:

java.io.IOException

fileUpToDateWhen

public void fileUpToDateWhen(<any> spec)

Description copied from interface: DownloadSpec

Spec to validate the already existing file this DownloadSpec will download. If this spec returns true, its considered up-to-date, as long as eTag and onlyIfModified checks pass, the file will not be re-downloaded.

Basically, using this allows you to determine externally if the file is corrupt and force a re-download at execution time instead of pre maturely.

Specified by:

fileUpToDateWhen in interface DownloadSpec

Parameters:

spec - The Spec.

getSrc

public java.net.URL getSrc()

Description copied from interface: DownloadSpec

Gets the source URL for the file that will be downloaded.

Specified by:

getSrc in interface DownloadSpec

Returns:

The URL.

getDest

public java.nio.file.Path getDest()

Description copied from interface: DownloadSpec

Gets the destination file to download to.

Specified by:

getDest in interface DownloadSpec

Returns:

The file.

getOnlyIfModified

public boolean getOnlyIfModified()

Specified by:

getOnlyIfModified in interface DownloadSpec

Returns:

If this DownloadSpec checks for onlyIfModified HTTP headers.

getUseETag

public DownloadAction.UseETag getUseETag()

Specified by:

getUseETag in interface DownloadSpec

Returns:

The ETag validation method used by this DownloadSpec.

getETagFile

public java.nio.file.Path getETagFile()

Description copied from interface: DownloadSpec

The file to store the ETag in. Defaults to getDest + .etag

Specified by:

getETagFile in interface DownloadSpec

Returns:

The file to store the ETag in.

getUserAgent

public java.lang.String getUserAgent()

Description copied from interface: DownloadSpec

Gets the User-Agent header this DownloadSpec will use for requests.

Specified by:

getUserAgent in interface DownloadSpec

Returns:

The User-Agent header.

isQuiet

public boolean isQuiet()

Description copied from interface: DownloadSpec

If this DownloadSpec is being quiet. Silences a few log messages and disables progress logging.

Specified by:

isQuiet in interface DownloadSpec

Returns:

If silent is enabled.

isUpToDate

public boolean isUpToDate()

Description copied from interface: DownloadSpec

To be used after the DownloadSpec has been executed, will return weather the DownloadSpec was up-to-date and no work was performed.

Specified by:

isUpToDate in interface DownloadSpec

Returns:

If the DownloadSpec was up-to-date.

getListener

public DownloadListener getListener()

Description copied from interface: DownloadSpec

Gets the currently attached DownloadListener.

Specified by:

getListener in interface DownloadSpec

Returns:

The Listener.

setSrc

public void setSrc(java.lang.Object src)

Description copied from interface: DownloadSpec

Sets the source URL to download.

Specified by:

setSrc in interface DownloadSpec

Parameters:

src - The source.

setDest

public void setDest(java.nio.file.Path dest)

Description copied from interface: DownloadSpec

Sets the destination to store the downloaded file.

Specified by:

setDest in interface DownloadSpec

Parameters:

dest - The destination.

setDest

public void setDest(java.io.File dest)

Description copied from interface: DownloadSpec

Sets the destination to store the downloaded file.

Specified by:

setDest in interface DownloadSpec

Parameters:

dest - The destination.

setOnlyIfModified

public void setOnlyIfModified(boolean onlyIfModified)

Description copied from interface: DownloadSpec

Sets weather this DownloadSpec should obey onlyIfModified HTTP headers.

Specified by:

setOnlyIfModified in interface DownloadSpec

Parameters:

onlyIfModified - Weather to use onlyIfModified.

setUseETag

public void setUseETag(java.lang.Object useETag)

Description copied from interface: DownloadSpec

Sets weather this DownloadSpec should use ETags for HTTP requests.

Specified by:

setUseETag in interface DownloadSpec

Parameters:

useETag - Weather to use ETags.

setETagFile

public void setETagFile(java.nio.file.Path eTagFile)

Description copied from interface: DownloadSpec

Sets the file to store the ETag in. This defaults to getDest + .etag

Specified by:

setETagFile in interface DownloadSpec

Parameters:

eTagFile - The file to store the ETag in.

setETagFile

public void setETagFile(java.io.File eTagFile)

Description copied from interface: DownloadSpec

Sets the file to store the ETag in. This defaults to getDest + .etag

Specified by:

setETagFile in interface DownloadSpec

Parameters:

eTagFile - The file to store the ETag in.

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Description copied from interface: DownloadSpec

Sets the User-Agent HTTP header string to use for HTTP requests.

Specified by:

setUserAgent in interface DownloadSpec

Parameters:

userAgent - The User-Agent string.

setQuiet

public void setQuiet(boolean quiet)

Description copied from interface: DownloadSpec

Sets weather quiet is enabled or not. Disables some log messages and progress logging.

Specified by:

setQuiet in interface DownloadSpec

Parameters:

quiet - If quiet is enabled.

setListener

public void setListener(DownloadListener listener)

Description copied from interface: DownloadSpec

Forcibly set the DownloadListener to use for this DownloadSpec. This bypasses quiet checks.

Specified by:

setListener in interface DownloadSpec

Parameters:

listener - The DownloadListener.