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

Class PrincipalLocaleResolver

java.lang.Object

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

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

All Implemented Interfaces:

org.springframework.web.servlet.LocaleResolver

public class PrincipalLocaleResolver
extends ConfigAwareLocaleResolver

Implementation of ConfigAwareLocaleResolver that extracts the locale from the current authenticated user

Supported configuration properties:

• attributeName: The name of the attribute to use, defaults to preferredLanguage

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	attributeName
static final String	CONFIG_KEY_ATTRIBUTE_NAME
static final String	DEFAULT_ATTRIBUTE_NAME

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

logger

Constructor Summary

Constructors

Constructor	Description
PrincipalLocaleResolver()

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, jakarta.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

DEFAULT_ATTRIBUTE_NAME

public static final String DEFAULT_ATTRIBUTE_NAME

See Also:

• Constant Field Values

CONFIG_KEY_ATTRIBUTE_NAME

public static final String CONFIG_KEY_ATTRIBUTE_NAME

See Also:

• Constant Field Values

attributeName

protected String attributeName

Constructor Details

PrincipalLocaleResolver

public PrincipalLocaleResolver()

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,
 jakarta.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