com.aquenos.cassandra.pvarchiver.server.web.common.spring

Class AcceptHeaderLocaleResolver

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.web.common.spring.AcceptHeaderLocaleResolver

All Implemented Interfaces:

LocaleResolver

public class AcceptHeaderLocaleResolver
extends Object
implements LocaleResolver

Locale resolver that selects the locale based on the Accept-Language header of the request. Unlike Spring's AcceptHeaderLocaleResolver, this implementation does not simply use the preferred locale from the request. Instead, it compares the list of locales requested by the client with a set of supported locales, choosing the most preferred locale that is also supported. If none of the locales requested by the client are supported, this implementation falls back to using a default locale.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
AcceptHeaderLocaleResolver()

Method Summary

Modifier and Type	Method and Description
Locale	getDefaultLocale() Returns the default locale.
Set<Locale>	getSupportedLocales() Returns the set of supported locales.
Locale	resolveLocale(HttpServletRequest request)
void	setDefaultLocale(Locale defaultLocale) Sets the default locale.
void	setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale)
void	setSupportedLocales(Set<Locale> supportedLocales) Replaces the set of supported locales.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcceptHeaderLocaleResolver

public AcceptHeaderLocaleResolver()

Method Detail

resolveLocale

public Locale resolveLocale(HttpServletRequest request)

Specified by:

resolveLocale in interface LocaleResolver

setLocale

public void setLocale(HttpServletRequest request,
                      HttpServletResponse response,
                      Locale locale)

Specified by:

setLocale in interface LocaleResolver

getDefaultLocale

public Locale getDefaultLocale()

Returns the default locale. The default locale is used when none of the locales requested by the clients are supported. If not configured explicitly, the default locale is the platform's default locale as returned by Locale.getDefault(). The default locale is never null.

Returns:

default locale used when none of the requested locales match any of the supported locales.

See Also:

getSupportedLocales()

setDefaultLocale

public void setDefaultLocale(Locale defaultLocale)

Sets the default locale. The default locale is used when none of the locales requested by the clients are supported. If not configured explicitly, the default locale is the platform's default locale as returned by Locale.getDefault().

Parameters:

defaultLocale - default locale to be used when none of the requested locales match any of the supported locales.

Throws:

NullPointerException - if defaultLocale is null.

See Also:

setSupportedLocales(Set)

getSupportedLocales

public Set<Locale> getSupportedLocales()

Returns the set of supported locales. This locale resolver compares the list of locales requested by the client against this set and uses the first requested locale that is supported. If none of the locales is supported, it falls back to the default locale. If not configured explicitly, the set of supported locales is empty, resulting in the default locale to be always selected. The set of supported locales is never null.

Returns:

set of supported locales.

See Also:

getDefaultLocale()

setSupportedLocales

public void setSupportedLocales(Set<Locale> supportedLocales)

Replaces the set of supported locales. This locale resolver compares the list of locales requested by the client against this set and uses the first requested locale that is supported. If none of the locales is supported, it falls back to the default locale. If not configured explicitly, the set of supported locales is empty, resulting in the default locale to always be selected.

Parameters:

supportedLocales - set of supported locales.

Throws:

NullPointerException - if supportedLocales is null or contains null elements.