Class HeaderLocaleResolver
java.lang.Object
org.craftercms.engine.util.spring.servlet.i18n.ConfigAwareLocaleResolver
org.craftercms.engine.util.spring.servlet.i18n.HeaderLocaleResolver
- All Implemented Interfaces:
org.springframework.web.servlet.LocaleResolver
Implementation of
ConfigAwareLocaleResolver
that reads the locale from a request header.
Supported configuration properties:
- headerName: The name of the request header, defaults to
Accept-Language
- Since:
- 4.0.0
- Author:
- joseross
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
init
(org.apache.commons.configuration2.HierarchicalConfiguration<?> config) Performs any customization neededprotected Locale
resolveLocale
(SiteContext siteContext, javax.servlet.http.HttpServletRequest request) Performs the actual work to resolve a localeMethods inherited from class org.craftercms.engine.util.spring.servlet.i18n.ConfigAwareLocaleResolver
isSupported, resolveLocale, setLocale, setSupportedLocales
-
Field Details
-
CONFIG_KEY_HEADER_NAME
- See Also:
-
DEFAULT_HEADER_NAME
- See Also:
-
headerName
The name of the header
-
-
Constructor Details
-
HeaderLocaleResolver
public HeaderLocaleResolver()
-
-
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 classConfigAwareLocaleResolver
- 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 classConfigAwareLocaleResolver
- Parameters:
siteContext
- the current site contextrequest
- the current request- Returns:
- a locale object or null
-