root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Improved SessionLocaleResolver documentation 

Issue: SPR-13505
This commit is contained in:
Juergen Hoeller 2015-10-28 14:30:08 +01:00
parent bc1dc9a074
commit 6d369308cc
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
spring-webmvc/src/main/java/org/springframework/web/servlet/i18n/SessionLocaleResolver.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -32,15 +32,25 @@ import org.springframework.web.util.WebUtils;
* accept-header locale.
*
* <p>This is most appropriate if the application needs user sessions anyway,
* that is, when the HttpSession does not have to be created for the locale.
* The session may optionally contain an associated time zone attribute as well;
* alternatively, you may specify a default time zone.
* i.e. when the {@code HttpSession} does not have to be created just for storing
* the user's locale. The session may optionally contain an associated time zone
* attribute as well; alternatively, you may specify a default time zone.
*
* <p>Custom controllers can override the user's locale and time zone by calling
* {@code #setLocale(Context)} on the resolver, e.g. responding to a locale change
* request. As a more convenient alternative, consider using
* {@link org.springframework.web.servlet.support.RequestContext#changeLocale}.
*
* <p>In contrast to {@link CookieLocaleResolver}, this strategy stores locally
* chosen locale settings in the Servlet container's {@code HttpSession}. As a
* consequence, those settings are just temporary for each session and therefore
* lost when each session terminates.
*
* <p>Note that there is no direct relationship with external session management
* mechanisms such as the "Spring Session" project. This {@code LocaleResolver}
* will simply evaluate and modify corresponding {@code HttpSession} attributes
* against the current {@code HttpServletRequest}.
*
* @author Juergen Hoeller
* @since 27.02.2003
* @see #setDefaultLocale

9
src/asciidoc/web-mvc.adoc
View File

@ -3286,7 +3286,14 @@ maximum age. Find below an example of defining a `CookieLocaleResolver`.
=== SessionLocaleResolver
The `SessionLocaleResolver` allows you to retrieve `Locale` and `TimeZone` from the
session that might be associated with the user's request.
session that might be associated with the user's request. In contrast to
`CookieLocaleResolver`, this strategy stores locally chosen locale settings in the
Servlet container's `HttpSession`. As a consequence, those settings are just temporary
for each session and therefore lost when each session terminates.
Note that there is no direct relationship with external session management mechanisms
such as the Spring Session project. This `SessionLocaleResolver` will simply evaluate and
modify corresponding `HttpSession` attributes against the current `HttpServletRequest`.