DownloadSpec (gradle-download-task 5.3.1 API)

All Known Implementing Classes:

Download, DownloadAction
```
public interface DownloadSpec
```
An interface for classes that perform file downloads

Method Summary

All Methods Instance Methods Abstract Methods
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
`void`	`eachFile(org.gradle.api.Action<? super DownloadDetails> action)` If multiple download sources are specified, this method adds an action to be applied to each source URL before it is downloaded.
`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.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`	`isPreemptiveAuth()`
`boolean`	`isQuiet()`
`boolean`	`isTempAndMove()`
`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`	`preemptiveAuth(boolean preemptiveAuth)` Specifies if preemptive Basic authentication should be enabled.
`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

- Method Detail
  - src
```
void src(java.lang.Object src)
  throws java.net.MalformedURLException
```
    Sets the download source URL
    
    Parameters:
    
    src - the URL
    
    Throws:
    
    java.net.MalformedURLException - if the download source is not a URL
  - dest
```
void dest(java.lang.Object dest)
```
    Sets the download destination
    
    Parameters:
    
    dest - a file or directory where to store the retrieved file
  - quiet
```
void quiet(boolean quiet)
```
    Sets the quiet flag
    
    Parameters:
    
    quiet - true if download progress should not be logged
  - overwrite
```
void overwrite(boolean overwrite)
```
    Sets the overwrite flag
    
    Parameters:
    
    overwrite - true if existing files should be overwritten, false otherwise
  - onlyIfModified
```
void onlyIfModified(boolean onlyIfModified)
```
    Sets the onlyIfModified flag
    
    Parameters:
    
    onlyIfModified - true if the file should only be downloaded if it has been modified on the server since the last download
  - onlyIfNewer
```
void onlyIfNewer(boolean onlyIfNewer)
```
    Sets the onlyIfNewer flag. This method is an alias for onlyIfModified(boolean).
    
    Parameters:
    
    onlyIfNewer - true if the file should only be downloaded if it has been modified on the server since the last download
  - compress
```
void compress(boolean compress)
```
    Specifies if compression should be used during download
    
    Parameters:
    
    compress - true if compression should be enabled
  - username
```
void username(java.lang.String username)
```
    Sets the username for authentication
    
    Parameters:
    
    username - the username
  - password
```
void password(java.lang.String password)
```
    Sets the password for authentication
    
    Parameters:
    
    password - the password
  - headers
```
void headers(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Sets the HTTP request headers to use when downloading
    
    Parameters:
    
    headers - a Map of header names to values
  - header
```
void header(java.lang.String name,
            java.lang.String value)
```
    Sets an HTTP request header to use when downloading
    
    Parameters:
    
    name - name of the HTTP header
    
    value - value of the HTTP header
  - preemptiveAuth
```
void preemptiveAuth(boolean preemptiveAuth)
```
    Specifies if preemptive Basic authentication should be enabled. By default, gradle-download-task automatically detects the required authentication scheme by sending two requests: one without credentials to determine the scheme based on the WWW-Authenticate header in the server's response and the actual request with credentials. This will fail if the server does not send a WWW-Authenticate header. In this case, set preemptiveAuth to true to use Basic authentication and to always send credentials in the first request.
    
    Note: Sending credentials in clear text in the first request without checking if the server actually needs them might pose a security risk.
    
    Parameters:
    
    preemptiveAuth - true if preemptive Basic authentication should be enabled
  - acceptAnyCertificate
```
void acceptAnyCertificate(boolean accept)
```
    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.
    
    Parameters:
    
    accept - true if certificate errors should be ignored (default: false)
  - connectTimeout
```
void connectTimeout(int milliseconds)
```
    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.
    
    Parameters:
    
    milliseconds - the timeout in milliseconds (default: -1)
  - readTimeout
```
void readTimeout(int milliseconds)
```
    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.
    
    Parameters:
    
    milliseconds - the timeout in milliseconds (default: -1)
  - retries
```
void retries(int retries)
```
    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.
    
    Parameters:
    
    retries - the maximum number of retries (default: 0)
  - downloadTaskDir
```
void downloadTaskDir(java.lang.Object dir)
```
    Specifies the directory where gradle-download-task stores information that should persist between builds
    
    Parameters:
    
    dir - the directory (default: ${buildDir}/gradle-download-task)
  - tempAndMove
```
void tempAndMove(boolean tempAndMove)
```
    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 downloadTaskDir(Object);
    
    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
```
void useETag(java.lang.Object useETag)
```
    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.
    Parameters:
    
    useETag - the flag's new value
  - cachedETagsFile
```
void cachedETagsFile(java.lang.Object location)
```
    Sets the location of the file that keeps entity tags (ETags) received from the server
    
    Parameters:
    
    location - the location (default: ${downloadTaskDir}/etags.json)
  - eachFile
```
void eachFile(org.gradle.api.Action<? super DownloadDetails> action)
```
    If multiple download sources are specified, this method adds an action to be applied to each source URL before it is downloaded. The action can modify some aspects of the target file in the destination directory specified by dest(Object) (for example, the file's name). If only one download source has been given, adding an action will lead to an IllegalArgumentException.
    
    Parameters:
    
    action - the action to add
  - getSrc
```
java.lang.Object getSrc()
```
    Returns:
    
    the download source(s), either a URL or a list of URLs
  - getDest
```
java.io.File getDest()
```
    Returns:
    
    the download destination
  - isQuiet
```
boolean isQuiet()
```
    Returns:
    
    the quiet flag
  - isOverwrite
```
boolean isOverwrite()
```
    Returns:
    
    the overwrite flag
  - isOnlyIfModified
```
boolean isOnlyIfModified()
```
    Returns:
    
    the onlyIfModified flag
  - isOnlyIfNewer
```
boolean isOnlyIfNewer()
```
    Get the onlyIfNewer flag. This method is an alias for isOnlyIfModified().
    
    Returns:
    
    the onlyIfNewer flag
  - isCompress
```
boolean isCompress()
```
    Returns:
    
    true if compression is enabled
  - getUsername
```
java.lang.String getUsername()
```
    Returns:
    
    the username for authentication
  - getPassword
```
java.lang.String getPassword()
```
    Returns:
    
    the password for authentication
  - isPreemptiveAuth
```
boolean isPreemptiveAuth()
```
    Returns:
    
    true if preemptive Basic authenticate is enabled
    
    See Also:
    
    preemptiveAuth(boolean)
  - getHeaders
```
java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    Returns:
    
    the HTTP request headers to use when downloading
  - getHeader
```
java.lang.String getHeader(java.lang.String name)
```
    Parameters:
    
    name - name of the HTTP header
    
    Returns:
    
    the value of the HTTP header
  - isAcceptAnyCertificate
```
boolean isAcceptAnyCertificate()
```
    Returns:
    
    true if HTTPS certificate verification errors should be ignored, default value is false
  - getConnectTimeout
```
int getConnectTimeout()
```
    Returns:
    
    the maximum time to wait in milliseconds until a connection is established
  - getReadTimeout
```
int getReadTimeout()
```
    Returns:
    
    the maximum time in milliseconds to wait for data from the server
  - getRetries
```
int getRetries()
```
    Returns:
    
    the maximum number of retries
  - getDownloadTaskDir
```
java.io.File getDownloadTaskDir()
```
    Returns:
    
    the directory where gradle-download-task stores information that should persist between builds
  - isTempAndMove
```
boolean isTempAndMove()
```
    Returns:
    
    true of if the file should be downloaded to a temporary location and, upon successful execution, moved to the final location.
  - getUseETag
```
java.lang.Object getUseETag()
```
    Returns:
    
    the value of the useETag flag
    
    See Also:
    
    useETag(Object)
  - getCachedETagsFile
```
java.io.File getCachedETagsFile()
```
    Returns:
    
    the location of the file that keeps entity tags (ETags) received from the server

Interface DownloadSpec

Method Summary

Method Detail

src

dest

quiet

overwrite

onlyIfModified

onlyIfNewer

compress

username

password

headers

header

preemptiveAuth

acceptAnyCertificate

connectTimeout

readTimeout

retries

downloadTaskDir

tempAndMove

useETag

cachedETagsFile

eachFile

getSrc

getDest

isQuiet

isOverwrite

isOnlyIfModified

isOnlyIfNewer

isCompress

getUsername

getPassword

isPreemptiveAuth

getHeaders

getHeader

isAcceptAnyCertificate

getConnectTimeout

getReadTimeout

getRetries

getDownloadTaskDir

isTempAndMove

getUseETag

getCachedETagsFile