SessionLocaleResolver (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.servlet.i18n.AbstractLocaleResolver
- - org.springframework.web.servlet.i18n.AbstractLocaleContextResolver
  - - org.springframework.web.servlet.i18n.SessionLocaleResolver

実装されているすべてのインターフェース:
LocaleContextResolver, LocaleResolver
```
public class SessionLocaleResolver
extends AbstractLocaleContextResolver
```
カスタム設定の場合、ユーザーのセッションでロケール属性を使用する LocaleResolver 実装。指定されたデフォルトロケールまたはリクエストの accept-header ロケールへのフォールバックを使用します。
これは、アプリケーションがユーザーセッションを必要とする場合、つまり、ユーザーのロケールを保存するためだけに HttpSession を作成する必要がない場合に最も適しています。セッションには、オプションで関連するタイムゾーン属性も含めることができます。または、デフォルトのタイムゾーンを指定できます。
カスタムコントローラーは、リゾルバーで #setLocale(Context) を呼び出すことにより、ユーザーのロケールとタイムゾーンをオーバーライドできます。ロケール変更リクエストへの応答。より便利な代替手段として、RequestContext.changeLocale(java.util.Locale) の使用を検討してください。
CookieLocaleResolver とは対照的に、この戦略はローカルに選択されたロケール設定をサーブレットコンテナーの HttpSession に保存します。結果として、これらの設定は各セッションに対して一時的なものであるため、各セッションが終了すると失われます。
"Spring Session" プロジェクトなどの外部セッション管理メカニズムと直接的な関連はないことに注意してください。この LocaleResolver は、単に現在の HttpServletRequest に対して対応する HttpSession 属性を評価および変更します。
導入:
27.02.2003
作成者:
Juergen Hoeller
関連事項:
AbstractLocaleResolver.setDefaultLocale(java.util.Locale), AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`LOCALE_SESSION_ATTRIBUTE_NAME` ロケールを保持するセッション属性の名前。
`static StringSE`	`TIME_ZONE_SESSION_ATTRIBUTE_NAME` TimeZone を保持するセッション属性の名前。

コンストラクターの概要
コンストラクター
コンストラクターと説明
SessionLocaleResolver()

コンストラクター
コンストラクターと説明
`SessionLocaleResolver()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected LocaleSE`	`determineDefaultLocale(HttpServletRequestEE request)` ロケールセッション属性が見つからない場合に呼び出される、指定されたリクエストのデフォルトロケールを決定します。
`protected TimeZoneSE`	`determineDefaultTimeZone(HttpServletRequestEE request)` 指定されたリクエストのデフォルトのタイムゾーンを決定します。TimeZone セッション属性が見つからない場合に呼び出されます。
`LocaleSE`	`resolveLocale(HttpServletRequestEE request)` 指定されたリクエストを介して現在のロケールを解決します。
`LocaleContext`	`resolveLocaleContext(HttpServletRequestEE request)` 指定されたリクエストを介して現在のロケールコンテキストを解決します。
`void`	`setLocaleAttributeName(StringSE localeAttributeName)` `HttpSession` の対応する属性の名前を指定し、現在の `Locale`SE 値を保持します。
`void`	`setLocaleContext(HttpServletRequestEE request, HttpServletResponseEE response, LocaleContext localeContext)` 現在のロケールコンテキストを指定されたものに設定します。潜在的に関連するタイムゾーン情報を持つロケールを含みます。
`void`	`setTimeZoneAttributeName(StringSE timeZoneAttributeName)` `HttpSession` の対応する属性の名前を指定し、現在の `TimeZone`SE 値を保持します。

クラス org.springframework.web.servlet.i18n.AbstractLocaleContextResolver から継承されたメソッド
getDefaultTimeZone, setDefaultTimeZone, setLocale

クラス org.springframework.web.servlet.i18n.AbstractLocaleResolver から継承されたメソッド
getDefaultLocale, setDefaultLocale

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - LOCALE_SESSION_ATTRIBUTE_NAME
```
public static final StringSE LOCALE_SESSION_ATTRIBUTE_NAME
```
    ロケールを保持するセッション属性の名前。この実装で内部的にのみ使用されます。
    RequestContext(Utils).getLocale() を使用して、コントローラーまたはビューの現在のロケールを取得します。
    関連事項:
    RequestContext.getLocale(), RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)
  - TIME_ZONE_SESSION_ATTRIBUTE_NAME
```
public static final StringSE TIME_ZONE_SESSION_ATTRIBUTE_NAME
```
    TimeZone を保持するセッション属性の名前。この実装で内部的にのみ使用されます。
    RequestContext(Utils).getTimeZone() を使用して、コントローラーまたはビューの現在のタイムゾーンを取得します。
    関連事項:
    RequestContext.getTimeZone(), RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)
- コンストラクターの詳細
  - SessionLocaleResolver
```
public SessionLocaleResolver()
```
- メソッドの詳細
  - setLocaleAttributeName
```
public void setLocaleAttributeName(StringSE localeAttributeName)
```
    HttpSession の対応する属性の名前を指定し、現在の LocaleSE 値を保持します。
    デフォルトは内部 LOCALE_SESSION_ATTRIBUTE_NAME です。
    導入:
    4.3.8
  - setTimeZoneAttributeName
```
public void setTimeZoneAttributeName(StringSE timeZoneAttributeName)
```
    HttpSession の対応する属性の名前を指定し、現在の TimeZoneSE 値を保持します。
    デフォルトは内部 TIME_ZONE_SESSION_ATTRIBUTE_NAME です。
    導入:
    4.3.8
  - resolveLocale
```
public LocaleSE resolveLocale(HttpServletRequestEE request)
```
    インターフェースからコピーされた説明: LocaleResolver
    指定されたリクエストを介して現在のロケールを解決します。いずれの場合でも、デフォルトロケールをフォールバックとして返すことができます。
    次で指定:
    インターフェース LocaleResolver の resolveLocale
    オーバーライド:
    クラス AbstractLocaleContextResolver の resolveLocale
    パラメーター:
    request - ロケールを解決するためのリクエスト
    戻り値:
    現在のロケール (非 null)
  - resolveLocaleContext
```
public LocaleContext resolveLocaleContext(HttpServletRequestEE request)
```
    インターフェースからコピーされた説明: LocaleContextResolver
    指定されたリクエストを介して現在のロケールコンテキストを解決します。
    これは主にフレームワークレベルの処理を目的としています。現在のロケールやタイムゾーンへのアプリケーションレベルのアクセスには、RequestContextUtils または RequestContext の使用を検討してください。
    返されるコンテキストは、タイムゾーン情報が関連付けられたロケールを含む TimeZoneAwareLocaleContext である場合があります。instanceof チェックを適用し、それに応じてダウンキャストするだけです。
    カスタムリゾルバーの実装は、返されたコンテキストで追加の設定を返すこともありますが、これもダウンキャストを通じてアクセスできます。
    パラメーター:
    request - ロケールコンテキストを解決するためのリクエスト
    戻り値:
    現在のロケールコンテキスト（非 null
    関連事項:
    LocaleResolver.resolveLocale(HttpServletRequest), RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest), RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)
  - setLocaleContext
```
public void setLocaleContext(HttpServletRequestEE request,
                             @Nullable
                             HttpServletResponseEE response,
                             @Nullable
                             LocaleContext localeContext)
```
    インターフェースからコピーされた説明: LocaleContextResolver
    現在のロケールコンテキストを指定されたものに設定します。潜在的に関連するタイムゾーン情報を持つロケールを含みます。
    パラメーター:
    request - ロケール変更に使用されるリクエスト
    response - ロケール変更に使用されるレスポンス
    localeContext - 新しいロケールコンテキスト、またはロケールをクリアする null
    関連事項:
    LocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale), SimpleLocaleContext, SimpleTimeZoneAwareLocaleContext
  - determineDefaultLocale
```
protected LocaleSE determineDefaultLocale(HttpServletRequestEE request)
```
    ロケールセッション属性が見つからない場合に呼び出される、指定されたリクエストのデフォルトロケールを決定します。
    デフォルトの実装は、指定されたデフォルトのロケールがあればそれを返します。それ以外の場合は、リクエストの accept-header ロケールにフォールバックします。
    パラメーター:
    request - ロケールを解決するためのリクエスト
    戻り値:
    デフォルトのロケール (非 null)
    関連事項:
    AbstractLocaleResolver.setDefaultLocale(java.util.Locale), ServletRequest.getLocale()EE
  - determineDefaultTimeZone
```
@Nullable
protected TimeZoneSE determineDefaultTimeZone(HttpServletRequestEE request)
```
    指定されたリクエストのデフォルトのタイムゾーンを決定します。TimeZone セッション属性が見つからない場合に呼び出されます。
    デフォルトの実装は、指定されたデフォルトのタイムゾーンがあればそれを返し、そうでなければ null を返します。
    パラメーター:
    request - タイムゾーンを解決するためのリクエスト
    戻り値:
    デフォルトのタイムゾーン (または定義されていない場合は null )
    関連事項:
    AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)

クラス SessionLocaleResolver

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.web.servlet.i18n.AbstractLocaleContextResolver から継承されたメソッド

クラス org.springframework.web.servlet.i18n.AbstractLocaleResolver から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

LOCALE_SESSION_ATTRIBUTE_NAME

TIME_ZONE_SESSION_ATTRIBUTE_NAME

コンストラクターの詳細

SessionLocaleResolver

メソッドの詳細

setLocaleAttributeName

setTimeZoneAttributeName

resolveLocale

resolveLocaleContext

setLocaleContext

determineDefaultLocale

determineDefaultTimeZone