org.springframework.mobile.device.site

Class CookieSitePreferenceRepository

java.lang.Object

org.springframework.web.util.CookieGenerator

org.springframework.mobile.device.site.CookieSitePreferenceRepository

All Implemented Interfaces:

SitePreferenceRepository

public class CookieSitePreferenceRepository
extends CookieGenerator
implements SitePreferenceRepository

SitePreferenceRepository implementation that stores user preference in a Cookie. Generally the preferred implementation. Extends CookieGenerator to allow for fine-grained control over the cookie attributes.

Author:

Keith Donald

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
CookieSitePreferenceRepository() Creates a cookie-based SitePreferenceRepository.
CookieSitePreferenceRepository(String cookieDomain) Creates a cookie-based SitePreferenceRepository with a custom domain value.

Method Summary

Methods

Modifier and Type	Method and Description
SitePreference	loadSitePreference(HttpServletRequest request) Load the user's site preference.
void	saveSitePreference(SitePreference preference, HttpServletRequest request, HttpServletResponse response) Save the user's site preference.

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

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

CookieSitePreferenceRepository

public CookieSitePreferenceRepository()

Creates a cookie-based SitePreferenceRepository. By default, the name of the cookie is org.springframework.mobile.device.site.CookiteSitePreferenceRepository.SITE_PREFERENCE

CookieSitePreferenceRepository

public CookieSitePreferenceRepository(String cookieDomain)

Creates a cookie-based SitePreferenceRepository with a custom domain value. Allows for convenient specification of to a shared domain such as .app.com.

Method Detail

saveSitePreference

public void saveSitePreference(SitePreference preference,
                      HttpServletRequest request,
                      HttpServletResponse response)

Description copied from interface: SitePreferenceRepository

Save the user's site preference.

Specified by:

saveSitePreference in interface SitePreferenceRepository

loadSitePreference

public SitePreference loadSitePreference(HttpServletRequest request)

Description copied from interface: SitePreferenceRepository

Load the user's site preference. Returns null if the user has not specified a preference.

Specified by:

loadSitePreference in interface SitePreferenceRepository