CookieLocaleResolver (Spring Framework 5.1.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.util.CookieGenerator
- - org.springframework.web.servlet.i18n.CookieLocaleResolver

実装されたすべてのインターフェース:
LocaleContextResolver, LocaleResolver
```
public class CookieLocaleResolver
extends CookieGenerator
implements LocaleContextResolver
```
指定されたデフォルトロケールまたはリクエストの accept-header ロケールへのフォールバックを使用して、カスタム設定の場合にユーザーに送り返される Cookie を使用する LocaleResolver 実装。
これは、ユーザーセッションのないステートレスアプリケーションに特に役立ちます。Cookie には、オプションで関連するタイムゾーン値も含めることができます。または、デフォルトのタイムゾーンを指定できます。
カスタムコントローラーは、リゾルバーで #setLocale(Context) を呼び出すことにより、ユーザーのロケールとタイムゾーンをオーバーライドできます。ロケール変更リクエストへの応答。より便利な代替手段として、RequestContext.changeLocale(java.util.Locale) の使用を検討してください。
導入:
27.02.2003
作成者:
Juergen Hoeller, Jean-Pierre Pawlak
関連事項:
setDefaultLocale(java.util.Locale), setDefaultTimeZone(java.util.TimeZone)

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_COOKIE_NAME` 明示的に設定されていない場合に使用されるデフォルトの Cookie 名。
`static StringSE`	`LOCALE_REQUEST_ATTRIBUTE_NAME` `Locale` を保持するリクエスト属性の名前。
`static StringSE`	`TIME_ZONE_REQUEST_ATTRIBUTE_NAME` `TimeZone` を保持するリクエスト属性の名前。

クラス org.springframework.web.util.CookieGenerator から継承されたフィールド
DEFAULT_COOKIE_PATH, logger

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`CookieLocaleResolver()` `default cookie name` を使用して、`CookieLocaleResolver` クラスの新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected LocaleSE`	`determineDefaultLocale(HttpServletRequestEE request)` 指定されたリクエストのデフォルトのロケールを決定します。ロケール Cookie が見つからない場合に呼び出されます。
`protected TimeZoneSE`	`determineDefaultTimeZone(HttpServletRequestEE request)` 指定されたリクエストのデフォルトのタイムゾーンを決定します。タイムゾーン Cookie が見つからない場合に呼び出されます。
`protected LocaleSE`	`getDefaultLocale()` Cookie が見つからない場合にこのリゾルバーが返す固定ロケールを返します（ある場合）。
`protected TimeZoneSE`	`getDefaultTimeZone()` Cookie が見つからない場合にこのリゾルバーが返す固定タイムゾーンを返します。
`boolean`	`isLanguageTagCompliant()` このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを返します。
`boolean`	`isRejectInvalidCookies()` 無効なコンテンツを含む Cookie を拒否するかどうかを返します（例:
`protected LocaleSE`	`parseLocaleValue(StringSE localeValue)` 受信 Cookie から取得した特定のロケール値を解析します。
`LocaleSE`	`resolveLocale(HttpServletRequestEE request)` 指定されたリクエストを介して現在のロケールを解決します。
`LocaleContext`	`resolveLocaleContext(HttpServletRequestEE request)` 指定されたリクエストを介して現在のロケールコンテキストを解決します。
`void`	`setDefaultLocale(LocaleSE defaultLocale)` Cookie が見つからない場合にこのリゾルバーが返す固定ロケールを設定します。
`void`	`setDefaultTimeZone(TimeZoneSE defaultTimeZone)` Cookie が見つからない場合にこのリゾルバーが返す固定タイムゾーンを設定します。
`void`	`setLanguageTagCompliant(boolean languageTagCompliant)` このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを指定します。
`void`	`setLocale(HttpServletRequestEE request, HttpServletResponseEE response, LocaleSE locale)` 現在のロケールを指定されたロケールに設定します。
`void`	`setLocaleContext(HttpServletRequestEE request, HttpServletResponseEE response, LocaleContext localeContext)` 現在のロケールコンテキストを指定されたものに設定します。潜在的に関連するタイムゾーン情報を持つロケールを含みます。
`void`	`setRejectInvalidCookies(boolean rejectInvalidCookies)` 無効なコンテンツを含む Cookie を拒否するかどうかを指定します（例:
`protected StringSE`	`toLocaleValue(LocaleSE locale)` 指定されたロケールを、Cookie に含めるためのテキスト値としてレンダリングします。

クラス org.springframework.web.util.CookieGenerator から継承されたメソッド
addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, removeCookie, setCookieDomain, setCookieHttpOnly, setCookieMaxAge, setCookieName, setCookiePath, setCookieSecure

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

- フィールドの詳細
  - LOCALE_REQUEST_ATTRIBUTE_NAME
```
public static final StringSE LOCALE_REQUEST_ATTRIBUTE_NAME
```
    Locale を保持するリクエスト属性の名前。
    現在のリクエストの過程でロケールが変更された場合にのみ、Cookie 値をオーバーライドするために使用されます！
    RequestContext(Utils).getLocale() を使用して、コントローラーまたはビューの現在のロケールを取得します。
    関連事項:
    RequestContext.getLocale(), RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)
  - TIME_ZONE_REQUEST_ATTRIBUTE_NAME
```
public static final StringSE TIME_ZONE_REQUEST_ATTRIBUTE_NAME
```
    TimeZone を保持するリクエスト属性の名前。
    現在のリクエストの過程でロケールが変更された場合にのみ、Cookie 値をオーバーライドするために使用されます！
    RequestContext(Utils).getTimeZone() を使用して、コントローラーまたはビューの現在のタイムゾーンを取得します。
    関連事項:
    RequestContext.getTimeZone(), RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)
  - DEFAULT_COOKIE_NAME
```
public static final StringSE DEFAULT_COOKIE_NAME
```
    明示的に設定されていない場合に使用されるデフォルトの Cookie 名。
- コンストラクターの詳細
  - CookieLocaleResolver
```
public CookieLocaleResolver()
```
    default cookie name を使用して、CookieLocaleResolver クラスの新しいインスタンスを作成します。
- メソッドの詳細
  - setLanguageTagCompliant
```
public void setLanguageTagCompliant(boolean languageTagCompliant)
```
    このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを指定します。
    デフォルトは 5.1 の時点で true です。これを false に切り替えて、Java のレガシーロケール仕様形式をレンダリングします。解析のために、このリゾルバーは、どのような場合でもレガシー Locale.toString()SE 形式と BCP 47 言語タグを寛容に受け入れます。
    導入:
    4.3
    関連事項:
    parseLocaleValue(String), toLocaleValue(Locale), Locale.forLanguageTag(String)SE, Locale.toLanguageTag()SE
  - isLanguageTagCompliant
```
public boolean isLanguageTagCompliant()
```
    このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを返します。
    導入:
    4.3
  - setRejectInvalidCookies
```
public void setRejectInvalidCookies(boolean rejectInvalidCookies)
```
    無効なコンテンツ（無効な形式など）を持つ Cookie を拒否するかどうかを指定します。
    デフォルトは true です。解析エラーの寛容な処理のためにこれをオフにし、そのような場合デフォルトのロケールとタイムゾーンにフォールバックします。
    導入:
    5.1.7
    関連事項:
    setDefaultLocale(java.util.Locale), setDefaultTimeZone(java.util.TimeZone), determineDefaultLocale(javax.servlet.http.HttpServletRequest), determineDefaultTimeZone(javax.servlet.http.HttpServletRequest)
  - isRejectInvalidCookies
```
public boolean isRejectInvalidCookies()
```
    無効なコンテンツ（無効な形式など）を持つ Cookie を拒否するかどうかを返します。
    導入:
    5.1.7
  - setDefaultLocale
```
public void setDefaultLocale(@Nullable
                             LocaleSE defaultLocale)
```
    Cookie が見つからない場合にこのリゾルバーが返す固定ロケールを設定します。
  - getDefaultLocale
```
@Nullable
protected LocaleSE getDefaultLocale()
```
    Cookie が見つからない場合にこのリゾルバーが返す固定ロケールを返します（ある場合）。
  - setDefaultTimeZone
```
public void setDefaultTimeZone(@Nullable
                               TimeZoneSE defaultTimeZone)
```
    Cookie が見つからない場合にこのリゾルバーが返す固定タイムゾーンを設定します。
    導入:
    4.0
  - getDefaultTimeZone
```
@Nullable
protected TimeZoneSE getDefaultTimeZone()
```
    Cookie が見つからない場合にこのリゾルバーが返す固定タイムゾーンを返します。
    導入:
    4.0
  - resolveLocale
```
public LocaleSE resolveLocale(HttpServletRequestEE request)
```
    インターフェースからコピーされた説明: LocaleResolver
    指定されたリクエストを介して現在のロケールを解決します。いずれの場合でも、デフォルトロケールをフォールバックとして返すことができます。
    次で指定:
    インターフェース LocaleResolver の resolveLocale
    パラメーター:
    request - ロケールを解決するためのリクエスト
    戻り値:
    現在のロケール (非 null)
  - resolveLocaleContext
```
public LocaleContext resolveLocaleContext(HttpServletRequestEE request)
```
    インターフェースからコピーされた説明: LocaleContextResolver
    指定されたリクエストを介して現在のロケールコンテキストを解決します。
    これは主にフレームワークレベルの処理を目的としています。現在のロケールやタイムゾーンへのアプリケーションレベルのアクセスには、RequestContextUtils または RequestContext の使用を検討してください。
    返されるコンテキストは、タイムゾーン情報が関連付けられたロケールを含む TimeZoneAwareLocaleContext である場合があります。instanceof チェックを適用し、それに応じてダウンキャストするだけです。
    カスタムリゾルバーの実装は、返されたコンテキストで追加の設定を返すこともありますが、これもダウンキャストを通じてアクセスできます。
    次で指定:
    インターフェース LocaleContextResolver の resolveLocaleContext
    パラメーター:
    request - ロケールコンテキストを解決するためのリクエスト
    戻り値:
    現在のロケールコンテキスト（非 null
    関連事項:
    LocaleResolver.resolveLocale(HttpServletRequest), RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest), RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)
  - setLocale
```
public void setLocale(HttpServletRequestEE request,
                      @Nullable
                      HttpServletResponseEE response,
                      @Nullable
                      LocaleSE locale)
```
    インターフェースからコピーされた説明: LocaleResolver
    現在のロケールを指定されたロケールに設定します。
    次で指定:
    インターフェース LocaleResolver の setLocale
    パラメーター:
    request - ロケール変更に使用されるリクエスト
    response - ロケール変更に使用されるレスポンス
    locale - 新しいロケール、またはロケールをクリアする null
  - setLocaleContext
```
public void setLocaleContext(HttpServletRequestEE request,
                             @Nullable
                             HttpServletResponseEE response,
                             @Nullable
                             LocaleContext localeContext)
```
    インターフェースからコピーされた説明: LocaleContextResolver
    現在のロケールコンテキストを指定されたものに設定します。潜在的に関連するタイムゾーン情報を持つロケールを含みます。
    次で指定:
    インターフェース LocaleContextResolver の setLocaleContext
    パラメーター:
    request - ロケール変更に使用されるリクエスト
    response - ロケール変更に使用されるレスポンス
    localeContext - 新しいロケールコンテキスト、またはロケールをクリアする null
    関連事項:
    LocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale), SimpleLocaleContext, SimpleTimeZoneAwareLocaleContext
  - parseLocaleValue
```
@Nullable
protected LocaleSE parseLocaleValue(StringSE localeValue)
```
    受信 Cookie から取得した特定のロケール値を解析します。
    デフォルトの実装は StringUtils.parseLocale(String) を呼び出し、Locale.toString()SE 形式と BCP 47 言語タグを受け入れます。
    パラメーター:
    localeValue - 解析するロケール値
    戻り値:
    対応する Locale インスタンス
    導入:
    4.3
    関連事項:
    StringUtils.parseLocale(String)
  - toLocaleValue
```
protected StringSE toLocaleValue(LocaleSE locale)
```
    指定されたロケールを、Cookie に含めるためのテキスト値としてレンダリングします。
    デフォルトの実装では、"languageTagCompliant" 構成プロパティに応じて、Locale.toString()SE または JDK 7 の Locale.toLanguageTag()SE を呼び出します。
    パラメーター:
    locale - 文字列化するロケール
    戻り値:
    指定されたロケールの文字列表現
    導入:
    4.3
    関連事項:
    isLanguageTagCompliant()
  - determineDefaultLocale
```
@Nullable
protected LocaleSE determineDefaultLocale(HttpServletRequestEE request)
```
    指定されたリクエストのデフォルトのロケールを決定します。ロケール Cookie が見つからない場合に呼び出されます。
    デフォルトの実装は、指定されたデフォルトのロケールがあればそれを返します。それ以外の場合は、リクエストの accept-header ロケールにフォールバックします。
    パラメーター:
    request - ロケールを解決するためのリクエスト
    戻り値:
    デフォルトのロケール (非 null)
    関連事項:
    setDefaultLocale(java.util.Locale), ServletRequest.getLocale()EE
  - determineDefaultTimeZone
```
@Nullable
protected TimeZoneSE determineDefaultTimeZone(HttpServletRequestEE request)
```
    指定されたリクエストのデフォルトのタイムゾーンを決定します。タイムゾーン Cookie が見つからない場合に呼び出されます。
    デフォルトの実装は、指定されたデフォルトのタイムゾーンがあればそれを返し、そうでなければ null を返します。
    パラメーター:
    request - タイムゾーンを解決するためのリクエスト
    戻り値:
    デフォルトのタイムゾーン (または定義されていない場合は null )
    関連事項:
    setDefaultTimeZone(java.util.TimeZone)

クラス CookieLocaleResolver

フィールドサマリー

クラス org.springframework.web.util.CookieGenerator から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.util.CookieGenerator から継承されたメソッド

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

フィールドの詳細

LOCALE_REQUEST_ATTRIBUTE_NAME

TIME_ZONE_REQUEST_ATTRIBUTE_NAME

DEFAULT_COOKIE_NAME

コンストラクターの詳細

CookieLocaleResolver

メソッドの詳細

setLanguageTagCompliant

isLanguageTagCompliant

setRejectInvalidCookies

isRejectInvalidCookies

setDefaultLocale

getDefaultLocale

setDefaultTimeZone

getDefaultTimeZone

resolveLocale

resolveLocaleContext

setLocale

setLocaleContext

parseLocaleValue

toLocaleValue

determineDefaultLocale

determineDefaultTimeZone