Adds a download task to Gradle that displays progress information
This is a download task for Gradle. It displays progress information just as Gradle does when it retrieves an artifact from a repository.
The plugin has been successfully tested with Gradle 2.0 up to 6.8. It should work with newer versions as well.
plugins { id "de.undercouch.download" version "4.1.1" }
buildscript { repositories { jcenter() } dependencies { classpath 'de.undercouch:gradle-download-task:4.1.1' } }apply plugin: 'de.undercouch.download'
After you have applied the plugin configuration (see above), you can use the
Downloadtask as follows:
task downloadFile(type: Download) { src 'http://www.example.com/index.html' dest buildDir }
By default, the plugin always performs a download even if the destination file already exists. If you want to prevent files from being downloaded again, use the
overwriteflag (see description below).
task downloadFile(type: Download) { src 'http://www.example.com/index.html' dest buildDir overwrite false }
As an alternative to the
Downloadtask, you may also use the
downloadextension to retrieve a file anywhere in your build script:
task myTask { doLast { //do something ... //... then download a file download { src 'http://www.example.com/index.html' dest buildDir overwrite false } //... do something else } }
The plugin requires:
If you need to run the plugin with Gradle 1.x or Java 6, use gradle-download-task version 3.4.3.
task downloadFile(type: Download) { src 'http://www.example.com/index.html' dest buildDir onlyIfModified true }
Note that this feature depends on the server and whether it supports the
If-Modified-Sincerequest header and provides a
Last-Modifiedtimestamp in its response.
task downloadMultipleFiles(type: Download) { src([ 'http://www.example.com/index.html', 'http://www.example.com/test.html' ]) dest buildDir }
Please note that you have to specify a directory as destination if you download multiple files. Otherwise, the plugin will fail.
If you want to download all files from a directory and the server provides a simple directory listing, you can use the following code:
task downloadDirectory { doLast { def dir = 'http://central.maven.org/maven2/de/undercouch/gradle-download-task/1.0/' def urlLister = new org.apache.ivy.util.url.ApacheURLLister() def files = urlLister.listFiles(new URL(dir)) download { src files dest buildDir } } }
To download and unpack a ZIP file, you can combine the download task plugin with Gradle's built-in support for ZIP files:
task downloadZipFile(type: Download) { src 'https://github.com/michel-kraemer/gradle-download-task/archive/1.0.zip' dest new File(buildDir, '1.0.zip') }task downloadAndUnzipFile(dependsOn: downloadZipFile, type: Copy) { from zipTree(downloadZipFile.dest) into buildDir }
Please have a look at the
examplesdirectory for more code samples. You can also read my blog post about common recipes for gradle-download-task.
The download task and the extension support the following properties.
true
if progress information should not be displayed
(default: false
)
true
if existing files should be overwritten (default:
true
)
true
if the file should only be downloaded if it
has been modified on the server since the last download (default:
false
)
Tip! You may provide Groovy Closures to the
srcand
destproperties to calculate their value at runtime.
true
if HTTPS certificate verification errors should be ignored
and any certificate (even an invalid one) should be accepted.
(default: false
)
true
if compression should be used during download (default:
true
)
0
(zero) means infinite timeout. A negative value
is interpreted as undefined. (default: 30 seconds
)
0
(zero) means infinite timeout. A negative value
is interpreted as undefined. (default: 30 seconds
)
0
,
failed requests are retried regardless of the actual error. This includes
failed connection attempts and file-not-found errors (404). A negative value
means infinite retries. (default: 0
)
Basic
or Digest
authentication
(optional)
Basic
or Digest
authentication
(optional)
Basic
and
Digest
). If username
and password
are
set, the default value of this property will be Basic
. Otherwise,
this property has no default value. (optional)
${buildDir}/download-task
)
true
if the file should be downloaded to a temporary location
and, upon successful execution, moved to the final location. If
overwrite
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
property. (default:
false
)
onlyIfModified
. If both
flags are true
, the plugin will check a file's timestamp as well
as its entity tag (ETag) and only download it if it has been modified on the
server since the last download. The plugin can differentiate between
strong and weak
ETags. Possible values are:
false
(default)
true
"all"
"strongOnly"
${downloadTaskDir}/etags.json
)
The plugin also provides a
Verifytask that can be used to check the integrity of a downloaded file by calculating its checksum and comparing it to a pre-defined value. The task succeeds if the file's checksum equals the given value and fails if it doesn't.
Use the task as follows:
task verifyFile(type: Verify) { src new File(buildDir, 'file.ext') algorithm 'MD5' checksum 'ce114e4501d2f4e2dcea3e17b546f339' }
You can combine the download task and the verify task as follows:
task downloadFile(type: Download) { src 'http://www.example.com/index.html' dest buildDir }task verifyFile(type: Verify, dependsOn: downloadFile) { src new File(buildDir, 'index.html') algorithm 'MD5' checksum '09b9c392dc1f6e914cea287cb6be34b0' }
The verify task supports the following properties:
MD5
)
You can configure a proxy server by setting standard JVM system properties. The plugin uses the same system properties as Gradle. You can set them in the build script directly. For example, the proxy host can be set as follows:
System.setProperty("http.proxyHost", "www.somehost.org");
Alternatively, you can set the properties in a
gradle.propertiesfile like this:
systemProp.http.proxyHost=www.somehost.org systemProp.http.proxyPort=8080 systemProp.http.proxyUser=userid systemProp.http.proxyPassword=password systemProp.http.nonProxyHosts=*.nonproxyrepos.com|localhost
Put this file in your project's root directory or in your Gradle home directory.
HTTPS is also supported:
systemProp.https.proxyHost=www.somehost.org systemProp.https.proxyPort=8080 systemProp.https.proxyUser=userid systemProp.https.proxyPassword=password systemProp.https.nonProxyHosts=*.nonproxyrepos.com|localhost
In gradle-download-task 4.x, we made the following breaking changes to the API:
timeoutproperty and introduced
connectTimeoutand
readTimeoutinstead. This allows you to control the individual timeouts better. Also, it improves compatibility with Gradle 5.x, where all tasks have a
timeoutproperty by default.
credentialsproperty has been removed. The same applies to the possibility to pass instances of Apache HttpClient's
AuthSchemeto the
authSchemeproperty. The strings
Basicand
Digestare now the only accepted values. There is no replacement. If you need this functionality, please file an issue.
requestInterceptorand
responseInterceptorhave been removed. There is no replacement. Again, if you need this functionality, please file an issue.
The plugin is licensed under the Apache License, Version 2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.