Spring Framework 6.1.4 · org.springframework.web.servlet.i18n.LocaleChangeInterceptor

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

Access	Constructor and Description
public	LocaleChangeInterceptor()

Method Summary

Modifier and Type	Method and Description
private boolean	checkHttpMethod(String currentMethod)
public String[]	getHttpMethods() Return the configured HTTP methods.
public String	getParamName() Return the name of the parameter that contains a locale specification in a locale change request.
public boolean	isIgnoreInvalidLocale() Return whether to ignore an invalid value for the locale parameter.
protected Locale	Returns: the corresponding `Locale` instance parseLocaleValue(String the locale value to parse localeValue) Parse the given locale value as coming from a request parameter.
public boolean	preHandle(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object chosen handler to execute, for type and/or instance evaluation handler) Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler.
public void	setHttpMethods(String... the methods httpMethods) Configure the HTTP method(s) over which the locale can be changed.
public void	setIgnoreInvalidLocale(boolean ignoreInvalidLocale) Set whether to ignore an invalid value for the locale parameter.
public void	setParamName(String paramName) Set the name of the parameter that contains a locale specification in a locale change request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_PARAM_NAME	back to summary
public static final String DEFAULT_PARAM_NAME Default name of the locale specification parameter: "locale".

httpMethods	back to summary
private String[] httpMethods Annotations @Nullable

ignoreInvalidLocale	back to summary
private boolean ignoreInvalidLocale

logger	back to summary
protected final Log logger

paramName	back to summary
private String paramName

LocaleChangeInterceptor	back to summary
public LocaleChangeInterceptor()

Method Detail

checkHttpMethod	back to summary
private boolean checkHttpMethod(String currentMethod)

getHttpMethods	back to summary
public String[] getHttpMethods() Return the configured HTTP methods. Annotations @Nullable Since 4.2

getHttpMethods

back to summary

public String[] getHttpMethods()

Return the configured HTTP methods.

Annotations

@Nullable

Since

4.2

getParamName	back to summary
public String getParamName() Return the name of the parameter that contains a locale specification in a locale change request.

isIgnoreInvalidLocale	back to summary
public boolean isIgnoreInvalidLocale() Return whether to ignore an invalid value for the locale parameter. Since 4.2.2

isIgnoreInvalidLocale

back to summary

public boolean isIgnoreInvalidLocale()

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

Since: 4.2.2

parseLocaleValue back to summary

parseLocaleValue	back to summary
protected Locale parseLocaleValue(String localeValue) Parse the given locale value as coming from a request parameter. The default implementation calls `StringUtils#parseLocale(String)`, accepting the `Locale#toString` format as well as BCP 47 language tags. Parameters localeValue:String the locale value to parse Returns:Locale the corresponding `Locale` instance Annotations @Nullable Since 4.3

protected Locale parseLocaleValue(String localeValue)

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

The default implementation calls StringUtils#parseLocale(String), accepting the Locale#toString format as well as BCP 47 language tags.

Parameters

localeValue:String: the locale value to parse

Returns:Locale

the corresponding Locale instance

Annotations

@Nullable

Since

4.3

preHandle back to summary

preHandle	back to summary
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler. DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response. Note special considerations apply for asynchronous request processing. For more details see `org.springframework.web.servlet.AsyncHandlerInterceptor`. The default implementation returns `true`. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object chosen handler to execute, for type and/or instance evaluation Returns:boolean `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. Annotations @Override

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

Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle.

Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle.

Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.

DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response.

Note

special considerations apply for asynchronous request processing. For more details see org.springframework.web.servlet.AsyncHandlerInterceptor.

The default implementation returns true.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: chosen handler to execute, for type and/or instance evaluation

Returns:boolean

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.

Annotations

@Override

setHttpMethods	back to summary
public void setHttpMethods(String... httpMethods) Configure the HTTP method(s) over which the locale can be changed. Parameters httpMethods:String[] the methods Since 4.2

setHttpMethods

back to summary

public void setHttpMethods(String... httpMethods)

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

Parameters

httpMethods:String[]: the methods

Since

4.2

setIgnoreInvalidLocale	back to summary
public void setIgnoreInvalidLocale(boolean ignoreInvalidLocale) Set whether to ignore an invalid value for the locale parameter. Since 4.2.2

setIgnoreInvalidLocale

back to summary

public void setIgnoreInvalidLocale(boolean ignoreInvalidLocale)

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

Since: 4.2.2

setParamName	back to summary
public void setParamName(String paramName) Set the name of the parameter that contains a locale specification in a locale change request. Default is "locale".

public Class LocaleChangeInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail