org.spincast.core.cookies

Interface CookiesRequestContextAddon<R extends RequestContext<?>>

All Known Implementing Classes:

SpincastCookiesRequestContextAddon

public interface CookiesRequestContextAddon<R extends RequestContext<?>>

Request context add-on to work with cookies.

Method Summary

Modifier and Type	Method and Description
void	addCookie(Cookie 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 available configurations.
Cookie	createCookie(String name) Creates a cookie.
void	deleteAllCookies() Deletes all cookies.
void	deleteCookie(String name) Deletes a cookie.
Cookie	getCookie(String name) Gets a cookie.
Map<String,Cookie>	getCookies() Gets the current cookies in a Map, using their names as the keys.
boolean	isCookiesEnabledValidated() Did we validate that the current user has cookies enabled?
void	resetCookies() Resets the current cookies to the original ones of the request.

Method Detail

getCookies

Map<String,Cookie> getCookies()

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

getCookie

Cookie getCookie(String name)

Gets a cookie.

Returns:

the cookie or null if not found.

addCookie

void addCookie(Cookie cookie)

Adds a cookie.

createCookie

Cookie createCookie(String name)

Creates a cookie. You then need to add it using addCookie(Cookie) if you want to send it.

By default, the public host (SpincastConfig.getPublicServerHost()) is uses as the cookie's domain and the cookie is valid for the time of the session only.

addCookie

void addCookie(String name,
               String value)

Adds a cookie using the specified name and value.

By default, the public host (SpincastConfig.getPublicServerHost()) is uses as the cookie's domain and the cookie is valid for the time of the session only.

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 available 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.

isCookiesEnabledValidated

boolean isCookiesEnabledValidated()

Did we validate that the current user has cookies enabled?