Package io.vertx.ext.web.client.spi
Interface CookieStore
-
public interface CookieStore
A cookie store that manages cookies for a single user; received for different domains and valid for different paths.- Author:
- Tommaso Nolli
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static CookieStore
build()
Builds an in memory cookie store.Iterable<Cookie>
get(Boolean ssl, String domain, String path)
Returns andIterable
of cookies satisfying the filters passed as paraemters.CookieStore
put(Cookie cookie)
Add a cookie to thisCookieStore
.CookieStore
remove(Cookie cookie)
Removes a previously added cookie.
-
-
-
Method Detail
-
build
static CookieStore build()
Builds an in memory cookie store.- Returns:
- the new cookie store
-
get
Iterable<Cookie> get(Boolean ssl, String domain, String path)
Returns andIterable
of cookies satisfying the filters passed as paraemters.It is implementation responsibility to return the appropriate cookies between the ones stored in this store and to clean up the path.
- Parameters:
ssl
- true if is the connection securedomain
- the domain we are callingpath
- the path we are calling- Returns:
- the matched cookies
-
put
CookieStore put(Cookie cookie)
Add a cookie to thisCookieStore
.If a cookie with the same name is received from the server, it will overwrite this setting.
- Parameters:
cookie
- theCookie
to add- Returns:
- a reference to this, so the API can be used fluently
-
remove
CookieStore remove(Cookie cookie)
Removes a previously added cookie.- Parameters:
cookie
- theCookie
to remove- Returns:
- a reference to this, so the API can be used fluently
-
-