org.springframework.web.servlet.i18n
Class CookieLocaleResolver

java.lang.Object
  org.springframework.web.util.CookieGenerator
      org.springframework.web.servlet.i18n.CookieLocaleResolver

All Implemented Interfaces:

LocaleResolver

public class CookieLocaleResolver

extends CookieGenerator

implements LocaleResolver

Implementation of LocaleResolver that uses a cookie sent back to the user in case of a custom setting, with a fallback to the accept header locale. This is particularly useful for stateless applications without user sessions.

Custom controllers can thus override the user's locale by calling setLocale, e.g. responding to a certain locale change request.

Since:

27.02.2003

Author:

Juergen Hoeller, Jean-Pierre Pawlak

See Also:

setLocale(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Locale)

Field Summary

static String	DEFAULT_COOKIE_NAME
static String	LOCALE_REQUEST_ATTRIBUTE_NAME Name of the request attribute that holds the locale.

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

DEFAULT_COOKIE_MAX_AGE, DEFAULT_COOKIE_PATH, logger

Constructor Summary

CookieLocaleResolver()

Method Summary

Locale	resolveLocale(HttpServletRequest request) Resolve the current locale via the given request.
void	setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) Set the current locale to the given one.

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

addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, removeCookie, setCookieDomain, setCookieMaxAge, setCookieName, setCookiePath

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_REQUEST_ATTRIBUTE_NAME

public static final String LOCALE_REQUEST_ATTRIBUTE_NAME

Name of the request attribute that holds the locale. Only used for overriding a cookie value if the locale has been changed in the course of the current request! Use RequestContext.getLocale() to retrieve the current locale in controllers or views.

See Also:

RequestContext.getLocale()

DEFAULT_COOKIE_NAME

public static final String DEFAULT_COOKIE_NAME

Constructor Detail

CookieLocaleResolver

public CookieLocaleResolver()

Method Detail

resolveLocale

public Locale resolveLocale(HttpServletRequest request)

Description copied from interface: LocaleResolver

Resolve the current locale via the given request. Should return a default locale as fallback in any case.

Specified by:

resolveLocale in interface LocaleResolver

Parameters:

request - request to be used for resolution

Returns:

the current locale

setLocale

public void setLocale(HttpServletRequest request,
                      HttpServletResponse response,
                      Locale locale)

Description copied from interface: LocaleResolver

Set the current locale to the given one.

Specified by:

setLocale in interface LocaleResolver

Parameters:

request - request to be used for locale modification

response - response to be used for locale modification

locale - the new locale