https://github.com/jacksgong/filedownloader-okhttp3-connection
The FileDownloadConnection implemented with the okhttp3
https://github.com/jacksgong/filedownloader-okhttp3-connection
connection filedownloader filedownloader-component filedownloader-okhttp3-connection okhttp
Last synced: about 1 year ago
JSON representation
The FileDownloadConnection implemented with the okhttp3
- Host: GitHub
- URL: https://github.com/jacksgong/filedownloader-okhttp3-connection
- Owner: Jacksgong
- License: apache-2.0
- Created: 2016-12-30T18:09:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T08:23:37.000Z (over 8 years ago)
- Last Synced: 2025-04-07T05:12:28.896Z (about 1 year ago)
- Topics: connection, filedownloader, filedownloader-component, filedownloader-okhttp3-connection, okhttp
- Language: Java
- Size: 75.2 KB
- Stars: 116
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# FileDownloader OkHttp3 Connection
A connection implemented with the OkHttp3 for FileDownloader.
[![Download][bintray_svg]][bintray_url]
![][file_downloader_svg]
[![Build Status][build_status_svg]][build_status_link]
## Usage
The simplest way to enable the connection with the okHttp3 for FileDownloader:
```java
// Init the FileDownloader with the OkHttp3Connection.Creator.
FileDownloader.init(context, new DownloadMgrInitialParams.InitCustomMaker()
.connectionCreator(new OkHttp3Connection.Creator()));
```
Alternatively, If you want to customize the `OkHttp3Client`, you can provide the `OkHttpClient.Builder` when create the `OkHttp3Connection.Creator`:
```java
// Enable the okHttp3 connection with the customized okHttp client builder.
final OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.connectTimeout(20_000, TimeUnit.SECONDS); // customize the value of the connect timeout.
// Init the FileDownloader with the OkHttp3Connection.Creator.
FileDownloader.setupOnApplicationOnCreate(this)
.connectionCreator(new OkHttp3Connection.Creator(builder));
```
## Installation
Adding the following dependency to your `build.gradle` file:
```groovy
dependencies {
compile 'cn.dreamtobe.filedownloader:filedownloader-okhttp3-connection:1.1.0'
}
```
## Okhttp3 Versioin and FileDownloader Version
If you want to dependency another newer version of Okhttp3 or FileDownloader, just feel free add on your `dependencies` block, such as:
> In this case, gradle will choose newer version dependency library instead.
```groovy
dependencies {
compile'cn.dreamtobe.filedownloader:filedownloader-okhttp3-connection:1.1.0'
compile 'com.squareup.okhttp3:okhttp:3.9.1'
compile 'com.liulishuo.filedownloader:library:1.7.0'
}
```
If you want to dependency another lower version of Okhttp3 or FileDownloader, you need to `exclude` it from filedownloader-okhttp3-connection first, then add it, such as:
```groovy
dependencies {
compile('cn.dreamtobe.filedownloader:filedownloader-okhttp3-connection:1.1.0') {
exclude module: 'okhttp'
exclude group: 'com.liulishuo.filedownloader', module: 'library'
}
compile 'com.squareup.okhttp3:okhttp:3.4.2'
compile 'com.liulishuo.filedownloader:library:1.6.9'
}
```
**Finally**, please don't forget to use `./gradlew dependencies` to check out the final relationship of dependencies on your project.
## Proguard Rule
because of okhttp, you need to add below `proguard-rules` to your project:
```
-dontwarn okhttp3.*
-dontwarn okio.**
```
## License
```
Copyright (C) 2016 Jacksgong(blog.dreamtobe.cn)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-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.
```
[file_downloader_svg]: https://img.shields.io/badge/Android-FileDownloader-orange.svg
[bintray_svg]: https://api.bintray.com/packages/jacksgong/maven/filedownloader-okhttp3-connection/images/download.svg
[bintray_url]: https://bintray.com/jacksgong/maven/filedownloader-okhttp3-connection/_latestVersion
[build_status_svg]: https://travis-ci.org/Jacksgong/filedownloader-okhttp3-connection.svg?branch=master
[build_status_link]: https://travis-ci.org/Jacksgong/filedownloader-okhttp3-connection