de.undercouch.gradle.tasks.download

Class DownloadAction

java.lang.Object

de.undercouch.gradle.tasks.download.DownloadAction

All Implemented Interfaces:

DownloadSpec

public class DownloadAction
extends java.lang.Object
implements DownloadSpec

Downloads a file and displays progress

Constructor Summary

Constructors

Constructor and Description
DownloadAction(org.gradle.api.Project project) Creates a new download action
DownloadAction(org.gradle.api.Project project, org.gradle.api.Task task) Creates a new download action

Method Summary

Modifier and Type	Method and Description
void	acceptAnyCertificate(boolean accept) Specifies if HTTPS certificate verification errors should be ignored and any certificate (even an invalid one) should be accepted.
void	cachedETagsFile(java.lang.Object location) Sets the location of the file that keeps entity tags (ETags) received from the server
void	compress(boolean compress) Specifies if compression should be used during download
void	connectTimeout(int milliseconds) Specifies the maximum time to wait in milliseconds until a connection is established.
void	dest(java.lang.Object dest) Sets the download destination
void	downloadTaskDir(java.lang.Object dir) Specifies the directory where gradle-download-task stores information that should persist between builds
java.util.concurrent.CompletableFuture<java.lang.Void>	execute() Starts downloading
java.util.concurrent.CompletableFuture<java.lang.Void>	execute(boolean throwOnError) Starts downloading
java.io.File	getCachedETagsFile()
int	getConnectTimeout()
java.io.File	getDest()
java.io.File	getDownloadTaskDir()
java.lang.String	getHeader(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
java.util.List<java.io.File>	getOutputFiles()
java.lang.String	getPassword()
int	getReadTimeout()
int	getRetries()
java.lang.Object	getSrc()
java.lang.Object	getUseETag()
java.lang.String	getUsername()
void	header(java.lang.String name, java.lang.String value) Sets an HTTP request header to use when downloading
void	headers(java.util.Map<java.lang.String,java.lang.String> headers) Sets the HTTP request headers to use when downloading
boolean	isAcceptAnyCertificate()
boolean	isCompress()
boolean	isOnlyIfModified()
boolean	isOnlyIfNewer() Get the onlyIfNewer flag.
boolean	isOverwrite()
boolean	isQuiet()
boolean	isTempAndMove()
boolean	isUpToDate()
void	onlyIfModified(boolean onlyIfModified) Sets the onlyIfModified flag
void	onlyIfNewer(boolean onlyIfNewer) Sets the onlyIfNewer flag.
void	overwrite(boolean overwrite) Sets the overwrite flag
void	password(java.lang.String password) Sets the password for authentication
void	quiet(boolean quiet) Sets the quiet flag
void	readTimeout(int milliseconds) Specifies the maximum time in milliseconds to wait for data from the server.
void	retries(int retries) Specifies the maximum number of retry attempts if a request has failed.
void	src(java.lang.Object src) Sets the download source URL
void	tempAndMove(boolean tempAndMove) Specifies whether the file should be downloaded to a temporary location and, upon successful execution, moved to the final location.
void	useETag(java.lang.Object useETag) Sets the useETag flag.
void	username(java.lang.String username) Sets the username for authentication

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadAction

public DownloadAction(org.gradle.api.Project project)

Creates a new download action

Parameters:

project - the project to be built

DownloadAction

public DownloadAction(org.gradle.api.Project project,
                      @Nullable
                      org.gradle.api.Task task)

Creates a new download action

Parameters:

project - the project to be built

task - the task to be executed, if applicable

Method Detail

execute

public java.util.concurrent.CompletableFuture<java.lang.Void> execute()
                                                               throws java.io.IOException

Starts downloading

Returns:

a CompletableFuture that completes once the download has finished

Throws:

java.io.IOException - if the file could not downloaded

execute

public java.util.concurrent.CompletableFuture<java.lang.Void> execute(boolean throwOnError)
                                                               throws java.io.IOException

Starts downloading

Parameters:

throwOnError - true if the asynchronous worker action should throw if the download fails. false if only the returned CompletableFuture should complete exceptionally.

Returns:

a CompletableFuture that completes once the download has finished

Throws:

java.io.IOException - if the file could not downloaded

isUpToDate

public boolean isUpToDate()

Returns:

true if the download destination is up to date

getOutputFiles

public java.util.List<java.io.File> getOutputFiles()

Returns:

a list of files created by this action (i.e. the destination files)

src

public void src(java.lang.Object src)

Description copied from interface: DownloadSpec

Sets the download source URL

Specified by:

src in interface DownloadSpec

Parameters:

src - the URL

dest

public void dest(java.lang.Object dest)

Description copied from interface: DownloadSpec

Sets the download destination

Specified by:

dest in interface DownloadSpec

Parameters:

dest - a file or directory where to store the retrieved file

quiet

public void quiet(boolean quiet)

Description copied from interface: DownloadSpec

Sets the quiet flag

Specified by:

quiet in interface DownloadSpec

Parameters:

quiet - true if download progress should not be logged

overwrite

public void overwrite(boolean overwrite)

Description copied from interface: DownloadSpec

Sets the overwrite flag

Specified by:

overwrite in interface DownloadSpec

Parameters:

overwrite - true if existing files should be overwritten, false otherwise

onlyIfModified

public void onlyIfModified(boolean onlyIfModified)

Description copied from interface: DownloadSpec

Sets the onlyIfModified flag

Specified by:

onlyIfModified in interface DownloadSpec

Parameters:

onlyIfModified - true if the file should only be downloaded if it has been modified on the server since the last download

onlyIfNewer

public void onlyIfNewer(boolean onlyIfNewer)

Description copied from interface: DownloadSpec

Sets the onlyIfNewer flag. This method is an alias for DownloadSpec.onlyIfModified(boolean).

Specified by:

onlyIfNewer in interface DownloadSpec

Parameters:

onlyIfNewer - true if the file should only be downloaded if it has been modified on the server since the last download

compress

public void compress(boolean compress)

Description copied from interface: DownloadSpec

Specifies if compression should be used during download

Specified by:

compress in interface DownloadSpec

Parameters:

compress - true if compression should be enabled

username

public void username(java.lang.String username)

Description copied from interface: DownloadSpec

Sets the username for authentication

Specified by:

username in interface DownloadSpec

Parameters:

username - the username

password

public void password(java.lang.String password)

Description copied from interface: DownloadSpec

Sets the password for authentication

Specified by:

password in interface DownloadSpec

Parameters:

password - the password

headers

public void headers(java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: DownloadSpec

Sets the HTTP request headers to use when downloading

Specified by:

headers in interface DownloadSpec

Parameters:

headers - a Map of header names to values

header

public void header(java.lang.String name,
                   java.lang.String value)

Description copied from interface: DownloadSpec

Sets an HTTP request header to use when downloading

Specified by:

header in interface DownloadSpec

Parameters:

name - name of the HTTP header

value - value of the HTTP header

acceptAnyCertificate

public void acceptAnyCertificate(boolean accept)

Description copied from interface: DownloadSpec

Specifies if HTTPS certificate verification errors should be ignored and any certificate (even an invalid one) should be accepted. By default certificates are validated and errors are not being ignored.

Specified by:

acceptAnyCertificate in interface DownloadSpec

Parameters:

accept - true if certificate errors should be ignored (default: false)

connectTimeout

public void connectTimeout(int milliseconds)

Description copied from interface: DownloadSpec

Specifies the maximum time to wait in milliseconds until a connection is established. A value of zero means infinite timeout. A negative value is interpreted as undefined.

Specified by:

connectTimeout in interface DownloadSpec

Parameters:

milliseconds - the timeout in milliseconds (default: -1)

readTimeout

public void readTimeout(int milliseconds)

Description copied from interface: DownloadSpec

Specifies the maximum time in milliseconds to wait for data from the server. A value of zero means infinite timeout. A negative value is interpreted as undefined.

Specified by:

readTimeout in interface DownloadSpec

Parameters:

milliseconds - the timeout in milliseconds (default: -1)

retries

public void retries(int retries)

Description copied from interface: DownloadSpec

Specifies the maximum number of retry attempts if a request has failed. By default, requests are never retried and the task fails immediately if the first request does not succeed.

Specified by:

retries in interface DownloadSpec

Parameters:

retries - the maximum number of retries (default: 0)

downloadTaskDir

public void downloadTaskDir(java.lang.Object dir)

Description copied from interface: DownloadSpec

Specifies the directory where gradle-download-task stores information that should persist between builds

Specified by:

downloadTaskDir in interface DownloadSpec

Parameters:

dir - the directory (default: ${buildDir}/gradle-download-task)

tempAndMove

public void tempAndMove(boolean tempAndMove)

Description copied from interface: DownloadSpec

Specifies whether the file should be downloaded to a temporary location and, upon successful execution, moved to the final location. If the overwrite flag is set to false, this flag is useful to avoid partially downloaded files if Gradle is forcefully closed or the system crashes. Note that the plugin always deletes partial downloads on connection errors, regardless of the value of this flag. The default temporary location can be configured with the DownloadSpec.downloadTaskDir(Object);

Specified by:

tempAndMove in interface DownloadSpec

Parameters:

tempAndMove - true if the file should be downloaded to a temporary location and, upon successful execution, moved to the final location (default: false)

useETag

public void useETag(java.lang.Object useETag)

Description copied from interface: DownloadSpec

Sets the useETag flag. Possible values are:

• true: check if the entity tag (ETag) of a downloaded file has changed and issue a warning if a weak ETag was encountered
• false: Do not use entity tags (ETags) at all
• "all": Use all ETags but do not issue a warning for weak ones
• "strongOnly": Use only strong ETags

Note that this flag is only effective if onlyIfModified is true.

Specified by:

useETag in interface DownloadSpec

Parameters:

useETag - the flag's new value

cachedETagsFile

public void cachedETagsFile(java.lang.Object location)

Description copied from interface: DownloadSpec

Sets the location of the file that keeps entity tags (ETags) received from the server

Specified by:

cachedETagsFile in interface DownloadSpec

Parameters:

location - the location (default: ${downloadTaskDir}/etags.json)

getSrc

public java.lang.Object getSrc()

Specified by:

getSrc in interface DownloadSpec

Returns:

the download source(s), either a URL or a list of URLs

getDest

public java.io.File getDest()

Specified by:

getDest in interface DownloadSpec

Returns:

the download destination

isQuiet

public boolean isQuiet()

Specified by:

isQuiet in interface DownloadSpec

Returns:

the quiet flag

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface DownloadSpec

Returns:

the overwrite flag

isOnlyIfModified

public boolean isOnlyIfModified()

Specified by:

isOnlyIfModified in interface DownloadSpec

Returns:

the onlyIfModified flag

isOnlyIfNewer

public boolean isOnlyIfNewer()

Description copied from interface: DownloadSpec

Get the onlyIfNewer flag. This method is an alias for DownloadSpec.isOnlyIfModified().

Specified by:

isOnlyIfNewer in interface DownloadSpec

Returns:

the onlyIfNewer flag

isCompress

public boolean isCompress()

Specified by:

isCompress in interface DownloadSpec

Returns:

true if compression is enabled

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface DownloadSpec

Returns:

the username for authentication

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface DownloadSpec

Returns:

the password for authentication

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Specified by:

getHeaders in interface DownloadSpec

Returns:

the HTTP request headers to use when downloading

getHeader

public java.lang.String getHeader(java.lang.String name)

Specified by:

getHeader in interface DownloadSpec

Parameters:

name - name of the HTTP header

Returns:

the value of the HTTP header

isAcceptAnyCertificate

public boolean isAcceptAnyCertificate()

Specified by:

isAcceptAnyCertificate in interface DownloadSpec

Returns:

true if HTTPS certificate verification errors should be ignored, default value is false

getConnectTimeout

public int getConnectTimeout()

Specified by:

getConnectTimeout in interface DownloadSpec

Returns:

the maximum time to wait in milliseconds until a connection is established

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface DownloadSpec

Returns:

the maximum time in milliseconds to wait for data from the server

getRetries

public int getRetries()

Specified by:

getRetries in interface DownloadSpec

Returns:

the maximum number of retries

getDownloadTaskDir

public java.io.File getDownloadTaskDir()

Specified by:

getDownloadTaskDir in interface DownloadSpec

Returns:

the directory where gradle-download-task stores information that should persist between builds

isTempAndMove

public boolean isTempAndMove()

Specified by:

isTempAndMove in interface DownloadSpec

Returns:

true of if the file should be downloaded to a temporary location and, upon successful execution, moved to the final location.

getUseETag

public java.lang.Object getUseETag()

Specified by:

getUseETag in interface DownloadSpec

Returns:

the value of the useETag flag

See Also:

DownloadSpec.useETag(Object)

getCachedETagsFile

public java.io.File getCachedETagsFile()

Specified by:

getCachedETagsFile in interface DownloadSpec

Returns:

the location of the file that keeps entity tags (ETags) received from the server