org.springframework.web.servlet
Interface LocaleResolver

All Known Implementing Classes:
AbstractLocaleResolver, AcceptHeaderLocaleResolver, CookieLocaleResolver, FixedLocaleResolver, SessionLocaleResolver

public interface LocaleResolver

Interface for web-based locale resolution strategies that allows for both locale resolution via the request and locale modification via request and response.

This interface allows for implementations based on request, session, cookies, etc. The default implementation is AcceptHeaderLocaleResolver, simply using the request's locale provided by the respective HTTP header.

Use RequestContext.getLocale() to retrieve the current locale in controllers or views, independent of the actual resolution strategy.

Since:
27.02.2003
Author:
Juergen Hoeller
See Also:
AcceptHeaderLocaleResolver, RequestContext.getLocale()

Method Summary
 java.util.Locale resolveLocale(javax.servlet.http.HttpServletRequest request)
          Resolve the current locale via the given request.
 void setLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Locale locale)
          Set the current locale to the given one.
 

Method Detail

resolveLocale

java.util.Locale resolveLocale(javax.servlet.http.HttpServletRequest request)
Resolve the current locale via the given request. Should return a default locale as fallback in any case.

Parameters:
request - the request to resolve the locale for
Returns:
the current locale (never null)

setLocale

void setLocale(javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response,
               java.util.Locale locale)
Set the current locale to the given one.

Parameters:
request - the request to be used for locale modification
response - the response to be used for locale modification
locale - the new locale, or null to clear the locale
Throws:
java.lang.UnsupportedOperationException - if the LocaleResolver implementation does not support dynamic changing of the theme