Skip to content

GH-36738: Document rendering-scope limitation of WebFlux RequestContext.changeLocale() #36894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
won-seoop wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

GH-36738: Document rendering-scope limitation of WebFlux RequestContext.changeLocale() #36894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions ...ng-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,31 @@ public TimeZone getTimeZone() {

/**
* Change the current locale to the specified one.
* <p><strong>Note:</strong> Unlike the Spring MVC counterpart, this method only
* updates the locale within the scope of the current {@code RequestContext} instance
* for view rendering purposes. It does <em>not</em> delegate to a
* {@link org.springframework.web.server.i18n.LocaleContextResolver} and the change
* is not persisted beyond the current rendering cycle. For a durable locale change
* across requests in WebFlux, configure a
* {@link org.springframework.web.server.i18n.LocaleContextResolver} and update it
* from a {@link org.springframework.web.server.WebFilter} or handler method instead.
* @param locale the new locale
* @see #changeLocale(java.util.Locale, java.util.TimeZone)
*/
public void changeLocale(Locale locale) {
this.locale = locale;
}

/**
* Change the current locale to the specified locale and time zone context.
* <p><strong>Note:</strong> Unlike the Spring MVC counterpart, this method only
* updates the locale and time zone within the scope of the current
* {@code RequestContext} instance for view rendering purposes. It does <em>not</em>
* delegate to a {@link org.springframework.web.server.i18n.LocaleContextResolver}
* and the change is not persisted beyond the current rendering cycle.
* @param locale the new locale
* @param timeZone the new time zone
* @see #changeLocale(java.util.Locale)
*/
public void changeLocale(Locale locale, TimeZone timeZone) {
this.locale = locale;
Expand Down