org.asynchttpclient.cookie

Class ThreadSafeCookieStore

java.lang.Object

org.asynchttpclient.cookie.ThreadSafeCookieStore

All Implemented Interfaces:

CookieStore

public final class ThreadSafeCookieStore
extends Object
implements CookieStore

Constructor Summary

Constructors

Constructor and Description
ThreadSafeCookieStore()

Method Summary

Modifier and Type	Method and Description
void	add(Uri uri, io.netty.handler.codec.http.cookie.Cookie cookie) Adds one Cookie to the store.
boolean	clear() Remove all cookies in this cookie store.
List<io.netty.handler.codec.http.cookie.Cookie>	get(Uri uri) Retrieve cookies associated with given URI, or whose domain matches the given URI.
List<io.netty.handler.codec.http.cookie.Cookie>	getAll() Get all not-expired cookies in cookie store.
boolean	remove(Predicate<io.netty.handler.codec.http.cookie.Cookie> predicate) Remove a cookie from store.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadSafeCookieStore

public ThreadSafeCookieStore()

Method Detail

add

public void add(Uri uri,
                io.netty.handler.codec.http.cookie.Cookie cookie)

Description copied from interface: CookieStore

Adds one Cookie to the store. This is called for every incoming HTTP response. If the given cookie has already expired it will not be added, but existing values will still be removed.

A cookie to store may or may not be associated with an URI. If it is not associated with an URI, the cookie's domain and path attribute will indicate where it comes from. If it is associated with an URI and its domain and path attribute are not specified, given URI will indicate where this cookie comes from.

If a cookie corresponding to the given URI already exists, then it is replaced with the new one.

Specified by:

add in interface CookieStore

Parameters:

uri - the uri this cookie associated with. if null, this cookie will not be associated with an URI

cookie - the cookie to be added

get

public List<io.netty.handler.codec.http.cookie.Cookie> get(Uri uri)

Description copied from interface: CookieStore

Retrieve cookies associated with given URI, or whose domain matches the given URI. Only cookies that have not expired are returned. This is called for every outgoing HTTP request.

Specified by:

get in interface CookieStore

Parameters:

uri - the uri associated with the cookies to be returned

Returns:

an immutable list of Cookie, return empty list if no cookies match the given URI

getAll

public List<io.netty.handler.codec.http.cookie.Cookie> getAll()

Description copied from interface: CookieStore

Get all not-expired cookies in cookie store.

Specified by:

getAll in interface CookieStore

Returns:

an immutable list of http cookies; return empty list if there's no http cookie in store

remove

public boolean remove(Predicate<io.netty.handler.codec.http.cookie.Cookie> predicate)

Description copied from interface: CookieStore

Remove a cookie from store.

Specified by:

remove in interface CookieStore

Parameters:

predicate - that indicates what cookies to remove

Returns:

true if this store contained the specified cookie

clear

public boolean clear()

Description copied from interface: CookieStore

Remove all cookies in this cookie store.

Specified by:

clear in interface CookieStore

Returns:

true if any cookies were purged.