程序包 cn.taketoday.web.i18n

类 SessionLocaleResolver

java.lang.Object

cn.taketoday.web.i18n.AbstractLocaleResolver

cn.taketoday.web.i18n.AbstractLocaleContextResolver

cn.taketoday.web.i18n.SessionLocaleResolver

所有已实现的接口:

LocaleContextResolver, LocaleResolver

public class SessionLocaleResolver
extends AbstractLocaleContextResolver

LocaleResolver implementation that uses a locale attribute in the user's session in case of a custom setting, with a fallback to the configured default locale, the request's Accept-Language header, or the default locale for the server.

This is most appropriate if the application needs user sessions anyway, i.e. when the 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.

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 "Session" project. This LocaleResolver will simply evaluate and modify corresponding HttpSession attributes against the current RequestContext.

从以下版本开始:

4.0

作者:

Juergen Hoeller

另请参阅:

• AbstractLocaleResolver.setDefaultLocale(java.util.Locale)
• AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)

字段概要

字段

修饰符和类型	字段	说明
static final String	LOCALE_SESSION_ATTRIBUTE_NAME	Default name of the session attribute that holds the Locale.
private String	localeAttributeName
private SessionManager	sessionManager
static final String	TIME_ZONE_SESSION_ATTRIBUTE_NAME	Default name of the session attribute that holds the TimeZone.
private String	timeZoneAttributeName

从接口继承的字段 cn.taketoday.web.LocaleResolver

BEAN_NAME

构造器概要

构造器

构造器	说明
SessionLocaleResolver()

方法概要

修饰符和类型	方法	说明
protected Locale	determineDefaultLocale(RequestContext request)	Determine the default locale for the given request, called if no Locale session attribute has been found.
protected TimeZone	determineDefaultTimeZone(RequestContext request)	Determine the default time zone for the given request, called if no TimeZone session attribute has been found.
private <T> T	getSessionAttribute(RequestContext request, String attributeName)
SessionManager	getSessionManager()
private SessionManager	getSessionManager(RequestContext request)
Locale	resolveLocale(RequestContext request)	Resolve the current locale via the given request.
cn.taketoday.core.i18n.LocaleContext	resolveLocaleContext(RequestContext request)	Resolve the current locale context via the given request.
void	setLocaleAttributeName(String localeAttributeName)	Specify the name of the corresponding attribute in the HttpSession, holding the current Locale value.
void	setLocaleContext(RequestContext request, cn.taketoday.core.i18n.LocaleContext localeContext)	Set the current locale context to the given one, potentially including a locale with associated time zone information.
private void	setSessionAttribute(RequestContext request, String attributeName, Object attribute)
void	setSessionManager(SessionManager sessionManager)
void	setTimeZoneAttributeName(String timeZoneAttributeName)	Specify the name of the corresponding attribute in the HttpSession, holding the current TimeZone value.

从类继承的方法 cn.taketoday.web.i18n.AbstractLocaleContextResolver

getDefaultTimeZone, setDefaultTimeZone, setLocale

从类继承的方法 cn.taketoday.web.i18n.AbstractLocaleResolver

getDefaultLocale, setDefaultLocale

从类继承的方法 java.lang.Object

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

字段详细资料

LOCALE_SESSION_ATTRIBUTE_NAME

public static final String LOCALE_SESSION_ATTRIBUTE_NAME

Default 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.

另请参阅:

• RequestContext.getLocale()
• RequestContextUtils.getLocale(cn.taketoday.web.RequestContext)

TIME_ZONE_SESSION_ATTRIBUTE_NAME

public static final String TIME_ZONE_SESSION_ATTRIBUTE_NAME

Default name of the session attribute that holds the TimeZone. Only used internally by this implementation.

Use RequestContext(Utils).getTimeZone() to retrieve the current time zone in controllers or views.

另请参阅:

• RequestContextUtils.getTimeZone(cn.taketoday.web.RequestContext)

localeAttributeName

private String localeAttributeName

timeZoneAttributeName

private String timeZoneAttributeName

sessionManager

@Nullable
private SessionManager sessionManager

构造器详细资料

SessionLocaleResolver

public SessionLocaleResolver()

方法详细资料

setLocaleAttributeName

public void setLocaleAttributeName(String localeAttributeName)

Specify the name of the corresponding attribute in the HttpSession, holding the current Locale value.

The default is an internal LOCALE_SESSION_ATTRIBUTE_NAME.

setTimeZoneAttributeName

public void setTimeZoneAttributeName(String timeZoneAttributeName)

Specify the name of the corresponding attribute in the HttpSession, holding the current TimeZone value.

The default is an internal TIME_ZONE_SESSION_ATTRIBUTE_NAME.

setSessionManager

public void setSessionManager(@Nullable
 SessionManager sessionManager)

getSessionManager

@Nullable
public SessionManager getSessionManager()

resolveLocale

public Locale resolveLocale(RequestContext request)

从接口复制的说明: LocaleResolver

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

指定者:

resolveLocale 在接口中 LocaleResolver

覆盖:

resolveLocale 在类中 AbstractLocaleContextResolver

参数:

request - the request to resolve the locale for

返回:

the current locale (never null)

resolveLocaleContext

public cn.taketoday.core.i18n.LocaleContext resolveLocaleContext(RequestContext request)

从接口复制的说明: LocaleContextResolver

Resolve the current locale context via the given request.

This is primarily intended for framework-level processing; consider using RequestContextUtils or RequestContext for application-level access to the current locale and/or time zone.

The returned context may be a TimeZoneAwareLocaleContext, containing a locale with associated time zone information. Simply apply an instanceof check and downcast accordingly.

Custom resolver implementations may also return extra settings in the returned context, which again can be accessed through downcasting.

参数:

request - the request to resolve the locale context for

返回:

the current locale context (never null

另请参阅:

• LocaleResolver.resolveLocale(RequestContext)
• RequestContextUtils.getLocale(cn.taketoday.web.RequestContext)
• RequestContextUtils.getTimeZone(cn.taketoday.web.RequestContext)

setLocaleContext

public void setLocaleContext(RequestContext request,
 @Nullable
 cn.taketoday.core.i18n.LocaleContext localeContext)

从接口复制的说明: LocaleContextResolver

Set the current locale context to the given one, potentially including a locale with associated time zone information.

参数:

request - the request to be used for locale modification

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

另请参阅:

• LocaleResolver.setLocale(RequestContext, Locale)
• SimpleLocaleContext
• SimpleTimeZoneAwareLocaleContext

getSessionAttribute

@Nullable
private <T> T getSessionAttribute(RequestContext request,
 String attributeName)

setSessionAttribute

private void setSessionAttribute(RequestContext request,
 String attributeName,
 @Nullable
 Object attribute)

getSessionManager

@Nullable
private SessionManager getSessionManager(RequestContext request)

determineDefaultLocale

protected Locale determineDefaultLocale(RequestContext request)

Determine the default locale for the given request, called if no Locale session attribute has been found.

The default implementation returns the configured default locale, if any, and otherwise falls back to the request's Accept-Language header locale or the default locale for the server.

参数:

request - the request to resolve the locale for

返回:

the default locale (never null)

另请参阅:

• AbstractLocaleResolver.setDefaultLocale(java.util.Locale)
• RequestContext.getLocale()

determineDefaultTimeZone

@Nullable
protected TimeZone determineDefaultTimeZone(RequestContext request)

Determine the default time zone for the given request, called if no TimeZone session attribute has been found.

The default implementation returns the configured default time zone, if any, or null otherwise.

参数:

request - the request to resolve the time zone for

返回:

the default time zone (or null if none defined)

另请参阅:

• AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)