Class LocaleChangeInterceptor

Field Detail

• DEFAULT_PARAM_NAME

  public static final String DEFAULT_PARAM_NAME

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

  See Also:

  Constant Field Values

• logger

  protected final Log logger

Constructor Detail

• LocaleChangeInterceptor

  public LocaleChangeInterceptor()

Method Detail

• setParamName

  public void setParamName​(String paramName)

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

• getParamName

  public String getParamName()

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

• setHttpMethods

  public void setHttpMethods​(String... httpMethods)

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

  Parameters:

  httpMethods - the methods

  Since:

  4.2

• getHttpMethods

  public 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,
                           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

• parseLocaleValue

  @UsesJava7
  protected Locale parseLocaleValue​(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