org.springframework.web.servlet.i18n
Class SessionLocaleResolver

java.lang.Object
  org.springframework.web.servlet.i18n.SessionLocaleResolver

All Implemented Interfaces:

LocaleResolver

public class SessionLocaleResolver
extends Object
implements LocaleResolver

Implementation of LocaleResolver that uses a locale attribute in the user's session in case of a custom setting, with a fallback to the accept header locale. This is most appropriate if the application needs user sessions anyway.

Custom controllers can override the user's locale by calling setLocale, e.g. responding to a locale change request.

Since:

27.02.2003

Author:

Juergen Hoeller

See Also:

setLocale(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Locale)

Field Summary

static String

LOCALE_SESSION_ATTRIBUTE_NAME Name of the session attribute that holds the locale.

Constructor Summary

SessionLocaleResolver()

Method Summary

Locale	resolveLocale(HttpServletRequest request) Resolve the current locale via the given request.
void	setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) Set the current locale to the given one.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_SESSION_ATTRIBUTE_NAME

public static final String LOCALE_SESSION_ATTRIBUTE_NAME

Name of the session attribute that holds the locale. Only used internally by this implementation. Use RequestContext(Utils).getLocale() to retrieve the current locale in controllers or views.

See Also:

RequestContext.getLocale(), RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)

Constructor Detail

SessionLocaleResolver

public SessionLocaleResolver()

Method Detail

resolveLocale

public Locale resolveLocale(HttpServletRequest request)

Description copied from interface: LocaleResolver

Resolve the current locale via the given request. Should return a default locale as fallback in any case.

Specified by:

resolveLocale in interface LocaleResolver

Parameters:

request - request to be used for resolution

Returns:

the current locale

setLocale

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

Description copied from interface: LocaleResolver

Set the current locale to the given one.

Specified by:

setLocale in interface LocaleResolver

Parameters:

request - request to be used for locale modification

response - response to be used for locale modification

locale - the new locale, or null to clear the locale