HeaderLocaleResolver (Crafter Engine 4.0.2 API)

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
```
public class HeaderLocaleResolver
extends ConfigAwareLocaleResolver
```
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

Fields
Modifier and Type Field Description

static String CONFIG_KEY_HEADER_NAME

static String DEFAULT_HEADER_NAME

protected String headerName
The name of the header

Constructor Summary

Constructors
Constructor Description

HeaderLocaleResolver()

Method Summary

All Methods Instance Methods Concrete Methods
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 Detail
  - CONFIG_KEY_HEADER_NAME
```
public static final String CONFIG_KEY_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEADER_NAME
```
public static final String DEFAULT_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - headerName
```
protected String headerName
```
    The name of the header
- Constructor Detail
  - HeaderLocaleResolver
```
public HeaderLocaleResolver()
```
- Method Detail
  - 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