public interface CookieStore extends Counted
Cookie
objects.
CookieManager
will call CookieStore.add
to save cookies
for every incoming HTTP response, and call CookieStore.get
to
retrieve cookie for every outgoing HTTP request. A CookieStore
is responsible for removing HttpCookie instances which have expired.
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.
|
void |
evictExpired()
Evicts all the cookies that expired as of the time this method is run.
|
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.
|
count, decrementAndGet, incrementAndGet
void add(Uri uri, io.netty.handler.codec.http.cookie.Cookie cookie)
Cookie
to the store. This is called for every incoming HTTP response.
If the given cookie has already expired it will not be added.
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.
uri
- the uri
this cookie associated with. if null
, this cookie will not be associated with an URIcookie
- the cookie
to be addedList<io.netty.handler.codec.http.cookie.Cookie> get(Uri uri)
uri
- the uri
associated with the cookies to be returnedList<io.netty.handler.codec.http.cookie.Cookie> getAll()
boolean remove(Predicate<io.netty.handler.codec.http.cookie.Cookie> predicate)
predicate
- that indicates what cookies to removetrue
if this store contained the specified cookieNullPointerException
- if cookie
is null
boolean clear()
void evictExpired()
Copyright © 2020. All rights reserved.