org.apereo.cas.web.support

Class CookieRetrievingCookieGenerator

java.lang.Object

org.springframework.web.util.CookieGenerator

org.apereo.cas.web.support.CookieRetrievingCookieGenerator

Direct Known Subclasses:

SessionStoreCookieGenerator, TGCCookieRetrievingCookieGenerator, TrustedDeviceCookieRetrievingCookieGenerator, WarningCookieRetrievingCookieGenerator, WsFederationCookieGenerator

public class CookieRetrievingCookieGenerator
extends org.springframework.web.util.CookieGenerator

Extends CookieGenerator to allow you to retrieve a value from a request. The cookie is automatically marked as httpOnly, if the servlet container has support for it. Also has support for remember-me.

Since:

3.1

Field Summary

Fields inherited from class org.springframework.web.util.CookieGenerator

DEFAULT_COOKIE_PATH, logger

Constructor Summary

Constructors

Constructor and Description
CookieRetrievingCookieGenerator(java.lang.String name, java.lang.String path, int maxAge, boolean secure, java.lang.String domain, boolean httpOnly)
CookieRetrievingCookieGenerator(java.lang.String name, java.lang.String path, int maxAge, boolean secure, java.lang.String domain, boolean httpOnly, CookieValueManager cookieValueManager)
CookieRetrievingCookieGenerator(java.lang.String name, java.lang.String path, int maxAge, boolean secure, java.lang.String domain, CookieValueManager casCookieValueManager, int rememberMeMaxAge, boolean httpOnly)

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String cookieValue) Add cookie.
void	addCookie(org.springframework.webflow.execution.RequestContext requestContext, java.lang.String cookieValue) Adds the cookie, taking into account RememberMeCredential.REQUEST_PARAMETER_REMEMBER_ME in the request.
protected javax.servlet.http.Cookie	createCookie(java.lang.String cookieValue)
java.lang.String	retrieveCookieValue(javax.servlet.http.HttpServletRequest request) Retrieve cookie value.
void	setCookieDomain(java.lang.String cookieDomain)

Methods inherited from class org.springframework.web.util.CookieGenerator

addCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, removeCookie, setCookieHttpOnly, setCookieMaxAge, setCookieName, setCookiePath, setCookieSecure

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieRetrievingCookieGenerator

public CookieRetrievingCookieGenerator(java.lang.String name,
                                       java.lang.String path,
                                       int maxAge,
                                       boolean secure,
                                       java.lang.String domain,
                                       boolean httpOnly)

CookieRetrievingCookieGenerator

public CookieRetrievingCookieGenerator(java.lang.String name,
                                       java.lang.String path,
                                       int maxAge,
                                       boolean secure,
                                       java.lang.String domain,
                                       boolean httpOnly,
                                       CookieValueManager cookieValueManager)

CookieRetrievingCookieGenerator

public CookieRetrievingCookieGenerator(java.lang.String name,
                                       java.lang.String path,
                                       int maxAge,
                                       boolean secure,
                                       java.lang.String domain,
                                       CookieValueManager casCookieValueManager,
                                       int rememberMeMaxAge,
                                       boolean httpOnly)

Method Detail

addCookie

public void addCookie(org.springframework.webflow.execution.RequestContext requestContext,
                      java.lang.String cookieValue)

Adds the cookie, taking into account RememberMeCredential.REQUEST_PARAMETER_REMEMBER_ME in the request.

Parameters:

requestContext - the request context

cookieValue - the cookie value

addCookie

public void addCookie(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      java.lang.String cookieValue)

Add cookie.

Parameters:

request - the request

response - the response

cookieValue - the cookie value

retrieveCookieValue

public java.lang.String retrieveCookieValue(javax.servlet.http.HttpServletRequest request)

Retrieve cookie value.

Parameters:

request - the request

Returns:

the cookie value

setCookieDomain

public void setCookieDomain(java.lang.String cookieDomain)

Overrides:

setCookieDomain in class org.springframework.web.util.CookieGenerator

createCookie

protected javax.servlet.http.Cookie createCookie(java.lang.String cookieValue)

Overrides:

createCookie in class org.springframework.web.util.CookieGenerator