org.jasig.cas.web.support

Class CookieRetrievingCookieGenerator

java.lang.Object

org.springframework.web.util.CookieGenerator

org.jasig.cas.web.support.CookieRetrievingCookieGenerator

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 RememberMe Services

Since:

3.1

Author:

Scott Battaglia, Misagh Moayyed

Field Summary

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

DEFAULT_COOKIE_MAX_AGE, DEFAULT_COOKIE_PATH, logger

Constructor Summary

Constructors

Constructor and Description
CookieRetrievingCookieGenerator() Instantiates a new cookie retrieving cookie generator with a default cipher of NoOpCookieValueManager.
CookieRetrievingCookieGenerator(CookieValueManager casCookieValueManager) Instantiates a new Cookie retrieving cookie generator.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String cookieValue) Adds the cookie, taking into account RememberMeCredential.REQUEST_PARAMETER_REMEMBER_ME in the request.
void	removeCookie(javax.servlet.http.HttpServletResponse response)
String	retrieveCookieValue(javax.servlet.http.HttpServletRequest request) Retrieve cookie value.
void	setRememberMeMaxAge(int maxAge)

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

addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, setCookieDomain, 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()

Instantiates a new cookie retrieving cookie generator with a default cipher of NoOpCookieValueManager.

CookieRetrievingCookieGenerator

public CookieRetrievingCookieGenerator(CookieValueManager casCookieValueManager)

Instantiates a new Cookie retrieving cookie generator.

Parameters:

casCookieValueManager - the cookie manager

Method Detail

addCookie

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

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

Parameters:

request - the request

response - the response

cookieValue - the cookie value

removeCookie

public void removeCookie(javax.servlet.http.HttpServletResponse response)

Overrides:

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

retrieveCookieValue

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

Retrieve cookie value.

Parameters:

request - the request

Returns:

the cookie value

setRememberMeMaxAge

public void setRememberMeMaxAge(int maxAge)