com.loopj.android.http

Class PersistentCookieStore

java.lang.Object

com.loopj.android.http.PersistentCookieStore

All Implemented Interfaces:

cz.msebera.android.httpclient.client.CookieStore

public class PersistentCookieStore
extends java.lang.Object
implements cz.msebera.android.httpclient.client.CookieStore

A persistent cookie store which implements the Apache HttpClient CookieStore interface. Cookies are stored and will persist on the user's device between application sessions since they are serialized and stored in SharedPreferences.

Instances of this class are designed to be used with AsyncHttpClient.setCookieStore(cz.msebera.android.httpclient.client.CookieStore), but can also be used with a regular old apache HttpClient/HttpContext if you prefer.

Constructor Summary

Constructors

Constructor and Description
PersistentCookieStore(android.content.Context context) Construct a persistent cookie store.

Method Summary

Modifier and Type	Method and Description
void	addCookie(cz.msebera.android.httpclient.cookie.Cookie cookie)
protected java.lang.String	byteArrayToHexString(byte[] bytes) Using some super basic byte array <-> hex conversions so we don't have to rely on any large Base64 libraries.
void	clear()
boolean	clearExpired(java.util.Date date)
protected cz.msebera.android.httpclient.cookie.Cookie	decodeCookie(java.lang.String cookieString) Returns cookie decoded from cookie string
void	deleteCookie(cz.msebera.android.httpclient.cookie.Cookie cookie) Non-standard helper method, to delete cookie
protected java.lang.String	encodeCookie(SerializableCookie cookie) Serializes Cookie object into String
java.util.List<cz.msebera.android.httpclient.cookie.Cookie>	getCookies()
protected byte[]	hexStringToByteArray(java.lang.String hexString) Converts hex values from strings to byte arra
void	setOmitNonPersistentCookies(boolean omitNonPersistentCookies) Will make PersistentCookieStore instance ignore Cookies, which are non-persistent by signature (`Cookie.isPersistent`)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentCookieStore

public PersistentCookieStore(android.content.Context context)

Construct a persistent cookie store.

Parameters:

context - Context to attach cookie store to

Method Detail

addCookie

public void addCookie(cz.msebera.android.httpclient.cookie.Cookie cookie)

Specified by:

addCookie in interface cz.msebera.android.httpclient.client.CookieStore

clear

public void clear()

Specified by:

clear in interface cz.msebera.android.httpclient.client.CookieStore

clearExpired

public boolean clearExpired(java.util.Date date)

Specified by:

clearExpired in interface cz.msebera.android.httpclient.client.CookieStore

getCookies

public java.util.List<cz.msebera.android.httpclient.cookie.Cookie> getCookies()

Specified by:

getCookies in interface cz.msebera.android.httpclient.client.CookieStore

setOmitNonPersistentCookies

public void setOmitNonPersistentCookies(boolean omitNonPersistentCookies)

Will make PersistentCookieStore instance ignore Cookies, which are non-persistent by signature (`Cookie.isPersistent`)

Parameters:

omitNonPersistentCookies - true if non-persistent cookies should be omited

deleteCookie

public void deleteCookie(cz.msebera.android.httpclient.cookie.Cookie cookie)

Non-standard helper method, to delete cookie

Parameters:

cookie - cookie to be removed

encodeCookie

protected java.lang.String encodeCookie(SerializableCookie cookie)

Serializes Cookie object into String

Parameters:

cookie - cookie to be encoded, can be null

Returns:

cookie encoded as String

decodeCookie

protected cz.msebera.android.httpclient.cookie.Cookie decodeCookie(java.lang.String cookieString)

Returns cookie decoded from cookie string

Parameters:

cookieString - string of cookie as returned from http request

Returns:

decoded cookie or null if exception occured

byteArrayToHexString

protected java.lang.String byteArrayToHexString(byte[] bytes)

Using some super basic byte array <-> hex conversions so we don't have to rely on any large Base64 libraries. Can be overridden if you like!

Parameters:

bytes - byte array to be converted

Returns:

string containing hex values

hexStringToByteArray

protected byte[] hexStringToByteArray(java.lang.String hexString)

Converts hex values from strings to byte arra

Parameters:

hexString - string of hex-encoded values

Returns:

decoded byte array