org.apereo.cas.web.support

Interface CookieValueManager

All Known Implementing Classes:

DefaultCasCookieValueManager, NoOpCookieValueManager

public interface CookieValueManager

The CookieValueManager is responsible for managing all cookies and their value structure for CAS. Implementations may choose to encode and sign the cookie value and optionally perform additional checks to ensure the integrity of the cookie.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildCookieValue(java.lang.String givenCookieValue, javax.servlet.http.HttpServletRequest request) Build cookie value.
java.lang.String	obtainCookieValue(javax.servlet.http.Cookie cookie, javax.servlet.http.HttpServletRequest request) Obtain cookie value.

Method Detail

buildCookieValue

java.lang.String buildCookieValue(java.lang.String givenCookieValue,
                                  javax.servlet.http.HttpServletRequest request)

Build cookie value.

Parameters:

givenCookieValue - the given cookie value

request - the request

Returns:

the original cookie value

obtainCookieValue

java.lang.String obtainCookieValue(javax.servlet.http.Cookie cookie,
                                   javax.servlet.http.HttpServletRequest request)

Obtain cookie value.

Parameters:

cookie - the cookie

request - the request

Returns:

the cookie value or null