Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franmontiel/persistentcookiejar
A persistent CookieJar implementation for OkHttp 3 based on SharedPreferences.
https://github.com/franmontiel/persistentcookiejar
android android-library cookiejar cookies okhttp3
Last synced: 3 days ago
JSON representation
A persistent CookieJar implementation for OkHttp 3 based on SharedPreferences.
- Host: GitHub
- URL: https://github.com/franmontiel/persistentcookiejar
- Owner: franmontiel
- License: apache-2.0
- Created: 2016-02-11T16:48:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T12:20:34.000Z (over 2 years ago)
- Last Synced: 2025-01-20T11:01:55.086Z (11 days ago)
- Topics: android, android-library, cookiejar, cookies, okhttp3
- Language: Java
- Homepage:
- Size: 89.8 KB
- Stars: 1,807
- Watchers: 50
- Forks: 248
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
PersistentCookieJar for OkHttp 3
===============================
A persistent CookieJar implementation for OkHttp 3 based on SharedPreferences.
If you're looking for a OkHttp 2/HTTPUrlConnection persistent CookieStore it can be found at [this Gist](https://gist.github.com/franmontiel/ed12a2295566b7076161).
Download
--------
Step 1. Add the JitPack repository in your root build.gradle at the end of repositories:
```groovy
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
Step 2. Add the dependency
```groovy
dependencies {
compile 'com.github.franmontiel:PersistentCookieJar:v1.0.1'
}
```
Usage
-----
Create an instance of `PersistentCookieJar` passing a `CookieCache` and a `CookiePersistor`:
```java
ClearableCookieJar cookieJar =
new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(context));
```
Then just add the CookieJar when building your OkHttp client:
```java
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.cookieJar(cookieJar)
.build();
```
Features
--------
This is a really simple library but here are some of the things that it provides:
* Possibility to clear the jar: `PersistentCookieJar` implements `ClearableCookieJar` interface that declares a `clear()` method for removing all cookies from the jar.
* Possibility to clear session cookies: `PersistentCookieJar` implements `ClearableCookieJar` interface that declares a `clearSession()` method for removing session cookies from the jar.
* Decoupled and extensible: `CookieCache` and `CookiePersistor` are interfaces so you can provide your own implementation for each one.
* `CookieCache` represents an in-memory cookie storage. `SetCookieCache` is the provided implementation that uses a Set to store the Cookies.
* `CookiePersistor` represents a persistent storage. `SharedPrefsCookiePersistor` is the provided implementation that uses a SharedPreferences to persist the Cookies.
* Thread-safe: `PersistentCookieJar` public methods are synchronized so there is no need to worry about threading if you need to implement a `CookieCache` or a `CookiePersistor`.
ProGuard
-------
The following configuration is only needed for version 0.9.2 and below:
```
-dontwarn com.franmontiel.persistentcookiejar.**
-keep class com.franmontiel.persistentcookiejar.**
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient ;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
```
License
-------
Copyright 2016 Francisco José Montiel Navarro
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.