Package org.craftercms.engine.util.spring.servlet.i18n

Class CookieLocaleResolver

java.lang.Object

org.craftercms.engine.util.spring.servlet.i18n.ConfigAwareLocaleResolver

org.craftercms.engine.util.spring.servlet.i18n.CookieLocaleResolver

All Implemented Interfaces:

org.springframework.web.servlet.LocaleResolver

public class CookieLocaleResolver
extends ConfigAwareLocaleResolver

Implementation of ConfigAwareLocaleResolver that reads the locale from a cookie.

Supported configuration properties:

• cookieName: The name of the cookie to read, the site name will be appended, defaults to a global configurable value

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_COOKIE_NAME
protected String	cookieName	The name of the cookie
protected String	defaultCookieName	The default name of the cookie, provided for backward compatibility

Fields inherited from class org.craftercms.engine.util.spring.servlet.i18n.ConfigAwareLocaleResolver

logger

Constructor Summary

Constructors

Constructor	Description
CookieLocaleResolver(String defaultCookieName)

Method Summary

Modifier and Type	Method	Description
protected void	init(org.apache.commons.configuration2.HierarchicalConfiguration<?> config)	Performs any customization needed
protected Locale	resolveLocale(SiteContext siteContext, javax.servlet.http.HttpServletRequest request)	Performs the actual work to resolve a locale

Methods inherited from class org.craftercms.engine.util.spring.servlet.i18n.ConfigAwareLocaleResolver

isSupported, resolveLocale, setLocale, setSupportedLocales

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_KEY_COOKIE_NAME

public static final String CONFIG_KEY_COOKIE_NAME

See Also:

• Constant Field Values

cookieName

protected String cookieName

The name of the cookie

defaultCookieName

protected String defaultCookieName

The default name of the cookie, provided for backward compatibility

Constructor Details

CookieLocaleResolver

@ConstructorProperties("defaultCookieName")
public CookieLocaleResolver(String defaultCookieName)

Method Details

init

protected void init(org.apache.commons.configuration2.HierarchicalConfiguration<?> config)

Description copied from class: ConfigAwareLocaleResolver

Performs any customization needed

Specified by:

init in class ConfigAwareLocaleResolver

Parameters:

config - the configuration

resolveLocale

protected Locale resolveLocale(SiteContext siteContext,
 javax.servlet.http.HttpServletRequest request)

Description copied from class: ConfigAwareLocaleResolver

Performs the actual work to resolve a locale

Specified by:

resolveLocale in class ConfigAwareLocaleResolver

Parameters:

siteContext - the current site context

request - the current request

Returns:

a locale object or null