org.craftercms.commons.http

Class CookieManager

java.lang.Object

org.craftercms.commons.http.CookieManager

public class CookieManager
extends Object

Utility class to create and delete cookies with common domain, path and max age.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_KEY_ADDED_COOKIE
static String	LOG_KEY_DELETED_COOKIE

Constructor Summary

Constructors

Constructor and Description
CookieManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(String name, String value, javax.servlet.http.HttpServletResponse response) Add a new cookie, using the configured domain, path and max age, to the response.
void	deleteCookie(String name, javax.servlet.http.HttpServletResponse response) Add a "delete" cookie to the response to indicate the that the stored cookie should be deleted.
void	setDomain(String domain)
void	setMaxAge(Integer maxAge)
void	setPath(String path)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_KEY_ADDED_COOKIE

public static final String LOG_KEY_ADDED_COOKIE

See Also:

Constant Field Values

LOG_KEY_DELETED_COOKIE

public static final String LOG_KEY_DELETED_COOKIE

See Also:

Constant Field Values

Constructor Detail

CookieManager

public CookieManager()

Method Detail

setDomain

public void setDomain(String domain)

setPath

public void setPath(String path)

setMaxAge

public void setMaxAge(Integer maxAge)

addCookie

public void addCookie(String name,
             String value,
             javax.servlet.http.HttpServletResponse response)

Add a new cookie, using the configured domain, path and max age, to the response.

Parameters:

name - the name of the cookie

value - the value of the cookie

deleteCookie

public void deleteCookie(String name,
                javax.servlet.http.HttpServletResponse response)

Add a "delete" cookie to the response to indicate the that the stored cookie should be deleted.

Parameters:

name - the name of the cookie