Class CookieLocaleResolver
- All Implemented Interfaces:
LocaleContextResolver,LocaleResolver
LocaleResolver implementation that uses a cookie sent back to the user
in case of a custom setting, with a fallback to the specified default locale
or the request's accept-header locale.
This is particularly useful for stateless applications without user sessions. The cookie may optionally contain an associated time zone value as well; alternatively, you may specify a default time zone.
Custom controllers can override the user's locale and time zone by calling
#setLocale(Context) on the resolver, e.g. responding to a locale change
request. As a more convenient alternative, consider using
RequestContext.changeLocale(java.util.Locale).
- Since:
- 27.02.2003
- Author:
- Juergen Hoeller, Jean-Pierre Pawlak
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe default cookie name used if none is explicitly set.static final StringThe name of the request attribute that holds theLocale.static final StringThe name of the request attribute that holds theTimeZone.Fields inherited from class org.springframework.web.util.CookieGenerator
DEFAULT_COOKIE_PATH, logger -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new instance of theCookieLocaleResolverclass using thedefault cookie name. -
Method Summary
Modifier and TypeMethodDescriptionprotected LocaledetermineDefaultLocale(HttpServletRequest request) Determine the default locale for the given request, Called if no locale cookie has been found.protected TimeZoneDetermine the default time zone for the given request, Called if no time zone cookie has been found.protected LocaleReturn the fixed locale that this resolver will return if no cookie found, if any.protected TimeZoneReturn the fixed time zone that this resolver will return if no cookie found, if any.booleanReturn whether this resolver's cookies should be compliant with BCP 47 language tags instead of Java's legacy locale specification format.booleanReturn whether to reject cookies with invalid content (e.g.protected LocaleparseLocaleValue(String localeValue) Parse the given locale value coming from an incoming cookie.resolveLocale(HttpServletRequest request) Resolve the current locale via the given request.resolveLocaleContext(HttpServletRequest request) Resolve the current locale context via the given request.voidsetDefaultLocale(Locale defaultLocale) Set a fixed locale that this resolver will return if no cookie found.voidsetDefaultTimeZone(TimeZone defaultTimeZone) Set a fixed time zone that this resolver will return if no cookie found.voidsetLanguageTagCompliant(boolean languageTagCompliant) Specify whether this resolver's cookies should be compliant with BCP 47 language tags instead of Java's legacy locale specification format.voidsetLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) Set the current locale to the given one.voidsetLocaleContext(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext) Set the current locale context to the given one, potentially including a locale with associated time zone information.voidsetRejectInvalidCookies(boolean rejectInvalidCookies) Specify whether to reject cookies with invalid content (e.g.protected StringtoLocaleValue(Locale locale) Render the given locale as a text value for inclusion in a cookie.Methods inherited from class org.springframework.web.util.CookieGenerator
addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, removeCookie, setCookieDomain, setCookieHttpOnly, setCookieMaxAge, setCookieName, setCookiePath, setCookieSecure
-
Field Details
-
LOCALE_REQUEST_ATTRIBUTE_NAME
The name of the request attribute that holds theLocale.Only used for overriding a cookie value if the locale has been changed in the course of the current request!
Use
RequestContext(Utils).getLocale()to retrieve the current locale in controllers or views. -
TIME_ZONE_REQUEST_ATTRIBUTE_NAME
The name of the request attribute that holds theTimeZone.Only used for overriding a cookie value if the locale has been changed in the course of the current request!
Use
RequestContext(Utils).getTimeZone()to retrieve the current time zone in controllers or views. -
DEFAULT_COOKIE_NAME
The default cookie name used if none is explicitly set.
-
-
Constructor Details
-
CookieLocaleResolver
public CookieLocaleResolver()Create a new instance of theCookieLocaleResolverclass using thedefault cookie name.
-
-
Method Details
-
setLanguageTagCompliant
public void setLanguageTagCompliant(boolean languageTagCompliant) Specify whether this resolver's cookies should be compliant with BCP 47 language tags instead of Java's legacy locale specification format.The default is
true, as of 5.1. Switch this tofalsefor rendering Java's legacy locale specification format. For parsing, this resolver leniently accepts the legacyLocale.toString()format as well as BCP 47 language tags in any case.- Since:
- 4.3
- See Also:
-
isLanguageTagCompliant
public boolean isLanguageTagCompliant()Return whether this resolver's cookies should be compliant with BCP 47 language tags instead of Java's legacy locale specification format.- Since:
- 4.3
-
setRejectInvalidCookies
public void setRejectInvalidCookies(boolean rejectInvalidCookies) Specify whether to reject cookies with invalid content (e.g. invalid format).The default is
true. Turn this off for lenient handling of parse failures, falling back to the default locale and time zone in such a case. -
isRejectInvalidCookies
public boolean isRejectInvalidCookies()Return whether to reject cookies with invalid content (e.g. invalid format).- Since:
- 5.1.7
-
setDefaultLocale
Set a fixed locale that this resolver will return if no cookie found. -
getDefaultLocale
Return the fixed locale that this resolver will return if no cookie found, if any. -
setDefaultTimeZone
Set a fixed time zone that this resolver will return if no cookie found.- Since:
- 4.0
-
getDefaultTimeZone
Return the fixed time zone that this resolver will return if no cookie found, if any.- Since:
- 4.0
-
resolveLocale
Description copied from interface:LocaleResolverResolve the current locale via the given request. Can return a default locale as fallback in any case.- Specified by:
resolveLocalein interfaceLocaleResolver- Parameters:
request- the request to resolve the locale for- Returns:
- the current locale (never
null)
-
resolveLocaleContext
Description copied from interface:LocaleContextResolverResolve the current locale context via the given request.This is primarily intended for framework-level processing; consider using
RequestContextUtilsorRequestContextfor application-level access to the current locale and/or time zone.The returned context may be a
TimeZoneAwareLocaleContext, containing a locale with associated time zone information. Simply apply aninstanceofcheck and downcast accordingly.Custom resolver implementations may also return extra settings in the returned context, which again can be accessed through downcasting.
- Specified by:
resolveLocaleContextin interfaceLocaleContextResolver- Parameters:
request- the request to resolve the locale context for- Returns:
- the current locale context (never
null - See Also:
-
setLocale
public void setLocale(HttpServletRequest request, @Nullable HttpServletResponse response, @Nullable Locale locale) Description copied from interface:LocaleResolverSet the current locale to the given one.- Specified by:
setLocalein interfaceLocaleResolver- Parameters:
request- the request to be used for locale modificationresponse- the response to be used for locale modificationlocale- the new locale, ornullto clear the locale
-
setLocaleContext
public void setLocaleContext(HttpServletRequest request, @Nullable HttpServletResponse response, @Nullable LocaleContext localeContext) Description copied from interface:LocaleContextResolverSet the current locale context to the given one, potentially including a locale with associated time zone information.- Specified by:
setLocaleContextin interfaceLocaleContextResolver- Parameters:
request- the request to be used for locale modificationresponse- the response to be used for locale modificationlocaleContext- the new locale context, ornullto clear the locale- See Also:
-
parseLocaleValue
Parse the given locale value coming from an incoming cookie.The default implementation calls
StringUtils.parseLocale(String), accepting theLocale.toString()format as well as BCP 47 language tags.- Parameters:
localeValue- the locale value to parse- Returns:
- the corresponding
Localeinstance - Since:
- 4.3
- See Also:
-
toLocaleValue
Render the given locale as a text value for inclusion in a cookie.The default implementation calls
Locale.toString()or JDK 7'sLocale.toLanguageTag(), depending on the"languageTagCompliant"configuration property.- Parameters:
locale- the locale to stringify- Returns:
- a String representation for the given locale
- Since:
- 4.3
- See Also:
-
determineDefaultLocale
Determine the default locale for the given request, Called if no locale cookie has been found.The default implementation returns the specified default locale, if any, else falls back to the request's accept-header locale.
- Parameters:
request- the request to resolve the locale for- Returns:
- the default locale (never
null) - See Also:
-
determineDefaultTimeZone
Determine the default time zone for the given request, Called if no time zone cookie has been found.The default implementation returns the specified default time zone, if any, or
nullotherwise.- Parameters:
request- the request to resolve the time zone for- Returns:
- the default time zone (or
nullif none defined) - See Also:
-