org.spincast.core.cookies

Interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

All Known Implementing Classes:

SpincastCookiesRequestContextAddon

public interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

Request context add-on to work with cookies.

Method Summary

Modifier and Type	Method and Description
void	addCookie(ICookie cookie) Adds a cookie.
void	addCookie(String name, String value) Adds a cookie using the specified name and value.
void	addCookie(String name, String value, String path, String domain, Date expires, boolean secure, boolean httpOnly, boolean discard, int version) Adds a cookie, using all possible configurations.
void	deleteAllCookies() Deletes all cookies.
void	deleteCookie(String name) Deletes a cookie.
ICookie	getCookie(String name) Gets a cookie.
Map<String,ICookie>	getCookies() Gets the current cookies in a Map, using their names as the keys.
void	resetCookies() Resets the current cookies to the original ones of the request.

Method Detail

getCookies

Map<String,ICookie> getCookies()

Gets the current cookies in a Map, using their names as the keys.

getCookie

ICookie getCookie(String name)

Gets a cookie.

Returns:

the cookie or null if not found.

addCookie

void addCookie(ICookie cookie)

Adds a cookie.

addCookie

void addCookie(String name,
               String value)

Adds a cookie using the specified name and value.

addCookie

void addCookie(String name,
               String value,
               String path,
               String domain,
               Date expires,
               boolean secure,
               boolean httpOnly,
               boolean discard,
               int version)

Adds a cookie, using all possible configurations.

deleteCookie

void deleteCookie(String name)

Deletes a cookie. In fact, this sets the cookie's expires date in the past so the user's browser will remove it. isExpired() will return true after you called this method.

deleteAllCookies

void deleteAllCookies()

Deletes all cookies. In fact, this sets their expires date in the past so the user's browser will remove them.

resetCookies

void resetCookies()

Resets the current cookies to the original ones of the request.