org.spincast.plugins.cookies

Class SpincastCookiesRequestContextAddon<R extends IRequestContext<?>>

java.lang.Object

org.spincast.plugins.cookies.SpincastCookiesRequestContextAddon<R>

All Implemented Interfaces:

ICookiesRequestContextAddon<R>

public class SpincastCookiesRequestContextAddon<R extends IRequestContext<?>>
extends Object
implements ICookiesRequestContextAddon<R>

Constructor Summary

Constructors

Constructor and Description
SpincastCookiesRequestContextAddon(R requestContext, IServer server, ICookieFactory cookieFactory)

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.
protected void	deleteCookie(ICookie cookie)
void	deleteCookie(String name) Deletes a cookie.
ICookie	getCookie(String name) Gets a cookie.
protected ICookieFactory	getCookieFactory()
Map<String,ICookie>	getCookies() Gets the current cookies in a Map, using their names as the keys.
protected R	getRequestContext()
protected IServer	getServer()
void	resetCookies() Resets the current cookies to the original ones of the request.
protected boolean	validateCookie(ICookie cookie)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpincastCookiesRequestContextAddon

@Inject
public SpincastCookiesRequestContextAddon(R requestContext,
                                                   IServer server,
                                                   ICookieFactory cookieFactory)

Method Detail

getRequestContext

protected R getRequestContext()

getServer

protected IServer getServer()

getCookieFactory

protected ICookieFactory getCookieFactory()

getCookie

public ICookie getCookie(String name)

Description copied from interface: ICookiesRequestContextAddon

Gets a cookie.

Specified by:

getCookie in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

Returns:

the cookie or null if not found.

addCookie

public void addCookie(ICookie cookie)

Description copied from interface: ICookiesRequestContextAddon

Adds a cookie.

Specified by:

addCookie in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

addCookie

public void addCookie(String name,
                      String value)

Description copied from interface: ICookiesRequestContextAddon

Adds a cookie using the specified name and value.

Specified by:

addCookie in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

addCookie

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

Description copied from interface: ICookiesRequestContextAddon

Adds a cookie, using all possible configurations.

Specified by:

addCookie in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

validateCookie

protected boolean validateCookie(ICookie cookie)

deleteCookie

public void deleteCookie(String name)

Description copied from interface: ICookiesRequestContextAddon

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.

Specified by:

deleteCookie in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

deleteAllCookies

public void deleteAllCookies()

Description copied from interface: ICookiesRequestContextAddon

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

Specified by:

deleteAllCookies in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

deleteCookie

protected void deleteCookie(ICookie cookie)

getCookies

public Map<String,ICookie> getCookies()

Description copied from interface: ICookiesRequestContextAddon

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

Specified by:

getCookies in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>

resetCookies

public void resetCookies()

Description copied from interface: ICookiesRequestContextAddon

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

Specified by:

resetCookies in interface ICookiesRequestContextAddon<R extends IRequestContext<?>>