org.springframework.web.servlet.i18n

Class LocaleChangeInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.springframework.web.servlet.i18n.LocaleChangeInterceptor

All Implemented Interfaces:

AsyncHandlerInterceptor, HandlerInterceptor

public class LocaleChangeInterceptor
extends HandlerInterceptorAdapter

Interceptor that allows for changing the current locale on every request, via a configurable request parameter (default parameter name: "locale").

Since:

20.06.2003

Author:

Juergen Hoeller, Rossen Stoyanchev

See Also:

LocaleResolver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PARAM_NAME Default name of the locale specification parameter: "locale".
private java.lang.String[]	httpMethods
private boolean	ignoreInvalidLocale
private boolean	languageTagCompliant
protected Log	logger
private java.lang.String	paramName

Constructor Summary

Constructors

Constructor and Description
LocaleChangeInterceptor()

Method Summary

Modifier and Type	Method and Description
private boolean	checkHttpMethod(java.lang.String currentMethod)
java.lang.String[]	getHttpMethods() Return the configured HTTP methods.
java.lang.String	getParamName() Return the name of the parameter that contains a locale specification in a locale change request.
boolean	isIgnoreInvalidLocale() Return whether to ignore an invalid value for the locale parameter.
boolean	isLanguageTagCompliant() Return whether to use BCP 47 language tags instead of Java's legacy locale specification format.
protected java.util.Locale	parseLocaleValue(java.lang.String locale) Parse the given locale value as coming from a request parameter.
boolean	preHandle(HttpServletRequest request, HttpServletResponse response, java.lang.Object handler) This implementation always returns true.
void	setHttpMethods(java.lang.String... httpMethods) Configure the HTTP method(s) over which the locale can be changed.
void	setIgnoreInvalidLocale(boolean ignoreInvalidLocale) Set whether to ignore an invalid value for the locale parameter.
void	setLanguageTagCompliant(boolean languageTagCompliant) Specify whether to parse request parameter values as BCP 47 language tags instead of Java's legacy locale specification format.
void	setParamName(java.lang.String paramName) Set the name of the parameter that contains a locale specification in a locale change request.

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

afterCompletion, afterConcurrentHandlingStarted, postHandle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARAM_NAME

public static final java.lang.String DEFAULT_PARAM_NAME

Default name of the locale specification parameter: "locale".

See Also:

Constant Field Values

logger

protected final Log logger

paramName

private java.lang.String paramName

httpMethods

private java.lang.String[] httpMethods

ignoreInvalidLocale

private boolean ignoreInvalidLocale

languageTagCompliant

private boolean languageTagCompliant

Constructor Detail

LocaleChangeInterceptor

public LocaleChangeInterceptor()

Method Detail

setParamName

public void setParamName(java.lang.String paramName)

Set the name of the parameter that contains a locale specification in a locale change request. Default is "locale".

getParamName

public java.lang.String getParamName()

Return the name of the parameter that contains a locale specification in a locale change request.

setHttpMethods

public void setHttpMethods(java.lang.String... httpMethods)

Configure the HTTP method(s) over which the locale can be changed.

Parameters:

httpMethods - the methods

Since:

4.2

getHttpMethods

public java.lang.String[] getHttpMethods()

Return the configured HTTP methods.

Since:

4.2

setIgnoreInvalidLocale

public void setIgnoreInvalidLocale(boolean ignoreInvalidLocale)

Set whether to ignore an invalid value for the locale parameter.

Since:

4.2.2

isIgnoreInvalidLocale

public boolean isIgnoreInvalidLocale()

Return whether to ignore an invalid value for the locale parameter.

Since:

4.2.2

setLanguageTagCompliant

public void setLanguageTagCompliant(boolean languageTagCompliant)

Specify whether to parse request parameter values as BCP 47 language tags instead of Java's legacy locale specification format. The default is false.

Note: This mode requires JDK 7 or higher. Set this flag to true for BCP 47 compliance on JDK 7+ only.

Since:

4.3

See Also:

Locale.forLanguageTag(String), Locale.toLanguageTag()

isLanguageTagCompliant

public boolean isLanguageTagCompliant()

Return whether to use BCP 47 language tags instead of Java's legacy locale specification format.

Since:

4.3

preHandle

public boolean preHandle(HttpServletRequest request,
                         HttpServletResponse response,
                         java.lang.Object handler)
                  throws ServletException

Description copied from class: HandlerInterceptorAdapter

This implementation always returns true.

Specified by:

preHandle in interface HandlerInterceptor

Overrides:

preHandle in class HandlerInterceptorAdapter

Parameters:

request - current HTTP request

response - current HTTP response

handler - chosen handler to execute, for type and/or instance evaluation

Returns:

true if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself.

Throws:

ServletException

checkHttpMethod

private boolean checkHttpMethod(java.lang.String currentMethod)

parseLocaleValue

protected java.util.Locale parseLocaleValue(java.lang.String locale)

Parse the given locale value as coming from a request parameter.

The default implementation calls StringUtils.parseLocaleString(String) or JDK 7's Locale.forLanguageTag(String), depending on the "languageTagCompliant" configuration property.

Parameters:

locale - the locale value to parse

Returns:

the corresponding Locale instance

Since:

4.3