public class CookieLocaleResolver extends CookieGenerator implements LocaleContextResolver
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).
setDefaultLocale(java.util.Locale),
setDefaultTimeZone(java.util.TimeZone)| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_COOKIE_NAME
The default cookie name used if none is explicitly set.
|
static String |
LOCALE_REQUEST_ATTRIBUTE_NAME
The name of the request attribute that holds the Locale.
|
static String |
TIME_ZONE_REQUEST_ATTRIBUTE_NAME
The name of the request attribute that holds the TimeZone.
|
DEFAULT_COOKIE_PATH, logger| Constructor and Description |
|---|
CookieLocaleResolver()
Create a new instance of the
CookieLocaleResolver class
using the default cookie name. |
| Modifier and Type | Method and Description |
|---|---|
protected Locale |
determineDefaultLocale(HttpServletRequest request)
Determine the default locale for the given request,
Called if no locale cookie has been found.
|
protected TimeZone |
determineDefaultTimeZone(HttpServletRequest request)
Determine the default time zone for the given request,
Called if no TimeZone cookie has been found.
|
protected Locale |
getDefaultLocale()
Return the fixed Locale that this resolver will return if no cookie found,
if any.
|
protected TimeZone |
getDefaultTimeZone()
Return the fixed TimeZone that this resolver will return if no cookie found,
if any.
|
boolean |
isLanguageTagCompliant()
Return whether this resolver's cookies should be compliant with BCP 47
language tags instead of Java's legacy locale specification format.
|
protected Locale |
parseLocaleValue(String locale)
Parse the given locale value coming from an incoming cookie.
|
Locale |
resolveLocale(HttpServletRequest request)
Resolve the current locale via the given request.
|
LocaleContext |
resolveLocaleContext(HttpServletRequest request)
Resolve the current locale context via the given request.
|
void |
setDefaultLocale(Locale defaultLocale)
Set a fixed Locale that this resolver will return if no cookie found.
|
void |
setDefaultTimeZone(TimeZone defaultTimeZone)
Set a fixed TimeZone that this resolver will return if no cookie found.
|
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.
|
void |
setLocale(HttpServletRequest request,
HttpServletResponse response,
Locale locale)
Set the current locale to the given one.
|
void |
setLocaleContext(HttpServletRequest request,
HttpServletResponse response,
LocaleContext localeContext)
Set the current locale context to the given one,
potentially including a locale with associated time zone information.
|
protected String |
toLocaleValue(Locale locale)
Render the given locale as a text value for inclusion in a cookie.
|
addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, removeCookie, setCookieDomain, setCookieHttpOnly, setCookieMaxAge, setCookieName, setCookiePath, setCookieSecurepublic static final String LOCALE_REQUEST_ATTRIBUTE_NAME
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.
public static final String TIME_ZONE_REQUEST_ATTRIBUTE_NAME
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.
public static final String DEFAULT_COOKIE_NAME
public CookieLocaleResolver()
CookieLocaleResolver class
using the default cookie name.public void setLanguageTagCompliant(boolean languageTagCompliant)
false.
Note: This mode requires JDK 7 or higher. Set this flag to true
for BCP 47 compliance on JDK 7+ only.
Locale.forLanguageTag(String),
Locale.toLanguageTag()public boolean isLanguageTagCompliant()
public void setDefaultLocale(Locale defaultLocale)
protected Locale getDefaultLocale()
public void setDefaultTimeZone(TimeZone defaultTimeZone)
protected TimeZone getDefaultTimeZone()
public Locale resolveLocale(HttpServletRequest request)
LocaleResolverresolveLocale in interface LocaleResolverrequest - the request to resolve the locale fornull)public LocaleContext resolveLocaleContext(HttpServletRequest request)
LocaleContextResolverThis is primarily intended for framework-level processing; consider using
RequestContextUtils or
RequestContext for
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 an instanceof check and downcast accordingly.
Custom resolver implementations may also return extra settings in the returned context, which again can be accessed through downcasting.
resolveLocaleContext in interface LocaleContextResolverrequest - the request to resolve the locale context fornullLocaleResolver.resolveLocale(HttpServletRequest),
RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest),
RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale)
LocaleResolversetLocale in interface LocaleResolverrequest - the request to be used for locale modificationresponse - the response to be used for locale modificationlocale - the new locale, or null to clear the localepublic void setLocaleContext(HttpServletRequest request, HttpServletResponse response, LocaleContext localeContext)
LocaleContextResolversetLocaleContext in interface LocaleContextResolverrequest - the request to be used for locale modificationresponse - the response to be used for locale modificationlocaleContext - the new locale context, or null to clear the localeLocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale),
SimpleLocaleContext,
SimpleTimeZoneAwareLocaleContextprotected Locale parseLocaleValue(String locale)
The default implementation calls StringUtils.parseLocaleString(String)
or JDK 7's Locale.forLanguageTag(String), depending on the
"languageTagCompliant" configuration property.
locale - the locale value to parseLocale instanceprotected String toLocaleValue(Locale locale)
The default implementation calls Locale.toString()
or JDK 7's Locale.toLanguageTag(), depending on the
"languageTagCompliant" configuration property.
locale - the locale to stringifyprotected Locale determineDefaultLocale(HttpServletRequest request)
The default implementation returns the specified default locale, if any, else falls back to the request's accept-header locale.
request - the request to resolve the locale fornull)setDefaultLocale(java.util.Locale),
ServletRequest.getLocale()protected TimeZone determineDefaultTimeZone(HttpServletRequest request)
The default implementation returns the specified default time zone,
if any, or null otherwise.
request - the request to resolve the time zone fornull if none defined)setDefaultTimeZone(java.util.TimeZone)