クラス CookieLocaleResolver

メソッドの詳細

• setCookieName

  @DeprecatedSE public void setCookieName(StringSE cookieName)

  使用すべきではありません。

  6.0 現在、CookieLocaleResolver(String) を推奨

  このリゾルバーによって作成される Cookie の名前を設定します。

  パラメーター:

  cookieName - クッキー名

• setCookieMaxAge

  public void setCookieMaxAge(DurationSE cookieMaxAge)

  Cookie "Max-Age" 属性を設定します。

  デフォルトでは、これは -1 に設定されており、この場合、Cookie はブラウザーがシャットダウンするまで保持されます。

  導入:

  6.0

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.maxAge(Duration)

• setCookieMaxAge

  @DeprecatedSE public void setCookieMaxAge(@Nullable IntegerSE cookieMaxAge)

  使用すべきではありません。

  6.0 現在、setCookieMaxAge(Duration) を推奨

  秒単位の値を持つ setCookieMaxAge(Duration) のバリアント。

• setCookiePath

  public void setCookiePath(@Nullable StringSE cookiePath)

  Cookie "Path" 属性を設定します。

  デフォルトでは、これは "/" に設定されています。

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.path(String)

• setCookieDomain

  public void setCookieDomain(@Nullable StringSE cookieDomain)

  Cookie "Domain" 属性を設定します。

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.domain(String)

• setCookieSecure

  public void setCookieSecure(boolean cookieSecure)

  "Secure" 属性を Cookie に追加します。

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.secure(boolean)

• setCookieHttpOnly

  public void setCookieHttpOnly(boolean cookieHttpOnly)

  "HttpOnly" 属性を Cookie に追加します。

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.httpOnly(boolean)

• setCookieSameSite

  public void setCookieSameSite(StringSE cookieSameSite)

  "SameSite" 属性を Cookie に追加します。

  デフォルトでは、これは "Lax" に設定されています。

  導入:

  6.0

  関連事項:

  • ResponseCookie.ResponseCookieBuilder.sameSite(String)

• setLanguageTagCompliant

  public void setLanguageTagCompliant(boolean languageTagCompliant)

  このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを指定します。

  デフォルトは 5.1 の時点で true です。これを false に切り替えて、Java のレガシーロケール仕様形式をレンダリングします。解析のために、このリゾルバーは、どのような場合でもレガシー Locale.toString() 形式と BCP 47 言語タグを寛容に受け入れます。

  導入:

  4.3

  関連事項:

  • parseLocaleValue(String)
  • toLocaleValue(Locale)
  • Locale.forLanguageTag(String)SE
  • Locale.toLanguageTag()

• isLanguageTagCompliant

  public boolean isLanguageTagCompliant()

  このリゾルバーの Cookie が Java のレガシーロケール仕様形式ではなく、BCP 47 言語タグに準拠する必要があるかどうかを返します。

  導入:

  4.3

• setRejectInvalidCookies

  public void setRejectInvalidCookies(boolean rejectInvalidCookies)

  無効なコンテンツ（無効な形式など）を持つ Cookie を拒否するかどうかを指定します。

  デフォルトは true です。解析エラーの寛容な処理のためにこれをオフにし、そのような場合デフォルトのロケールとタイムゾーンにフォールバックします。

  導入:

  5.1.7

  関連事項:

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

• isRejectInvalidCookies

  public boolean isRejectInvalidCookies()

  無効なコンテンツ（無効な形式など）を持つ Cookie を拒否するかどうかを返します。

  導入:

  5.1.7

• setDefaultLocaleFunction

  public void setDefaultLocaleFunction(FunctionSE<HttpServletRequestEE,LocaleSE> defaultLocaleFunction)

  指定されたリクエストのデフォルトロケールを決定するために使用される関数を設定します。ロケール Cookie が見つからない場合に呼び出されます。

  デフォルトの実装は、構成されたデフォルトのロケールを返します（存在する場合）。それ以外の場合は、リクエストの Accept-Language ヘッダーロケールまたはサーバーのデフォルトのロケールにフォールバックします。

  パラメーター:

  defaultLocaleFunction - デフォルトのロケールを決定するために使用される関数

  導入:

  6.0

  関連事項:

  • AbstractLocaleResolver.setDefaultLocale(java.util.Locale)
  • ServletRequest.getLocale()EE

• setDefaultTimeZoneFunction

  public void setDefaultTimeZoneFunction(FunctionSE<HttpServletRequestEE,TimeZoneSE> defaultTimeZoneFunction)

  指定されたリクエストのデフォルトのタイムゾーンを決定するために使用される関数を設定します。ロケール Cookie が見つからない場合に呼び出されます。

  デフォルトの実装は、構成されたデフォルトのタイムゾーン（存在する場合）を返し、そうでない場合は null を返します。

  パラメーター:

  defaultTimeZoneFunction - デフォルトのタイムゾーンを決定するために使用される関数

  導入:

  6.0

  関連事項:

  • AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)

• resolveLocale

  public LocaleSE resolveLocale(HttpServletRequestEE request)

  インターフェースからコピーされた説明: LocaleContextResolver

  LocaleContextResolver.resolveLocaleContext(HttpServletRequest) に委譲し、必要に応じて ServletRequest.getLocale()EE にフォールバックする LocaleResolver.resolveLocale(HttpServletRequest) のデフォルト実装。

  パラメーター:

  request - ロケールを解決するためのリクエスト

  戻り値:

  現在のロケール (非 null)

• resolveLocaleContext

  public LocaleContext resolveLocaleContext(HttpServletRequestEE request)

  インターフェースからコピーされた説明: LocaleContextResolver

  指定されたリクエストを介して現在のロケールコンテキストを解決します。

  これは主にフレームワークレベルの処理を目的としています。現在のロケールやタイムゾーンへのアプリケーションレベルのアクセスには、RequestContextUtils または RequestContext の使用を検討してください。

  返されるコンテキストは、タイムゾーン情報が関連付けられたロケールを含む TimeZoneAwareLocaleContext である場合があります。instanceof チェックを適用し、それに応じてダウンキャストするだけです。

  カスタムリゾルバーの実装は、返されたコンテキストで追加の設定を返すこともありますが、これもダウンキャストを通じてアクセスできます。

  パラメーター:

  request - ロケールコンテキストを解決するためのリクエスト

  戻り値:

  現在のロケールコンテキスト（非 null

  関連事項:

  • LocaleContextResolver.resolveLocale(HttpServletRequest)
  • RequestContextUtils.getLocale(jakarta.servlet.http.HttpServletRequest)
  • RequestContextUtils.getTimeZone(jakarta.servlet.http.HttpServletRequest)

• setLocaleContext

  public void setLocaleContext(HttpServletRequestEE request, @Nullable HttpServletResponseEE response, @Nullable LocaleContext localeContext)

  インターフェースからコピーされた説明: LocaleContextResolver

  現在のロケールコンテキストを指定されたものに設定します。潜在的に関連するタイムゾーン情報を持つロケールを含みます。

  パラメーター:

  request - ロケール変更に使用されるリクエスト

  response - ロケール変更に使用されるレスポンス

  localeContext - 新しいロケールコンテキスト、またはロケールをクリアする null 

  関連事項:

  • LocaleContextResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale)
  • SimpleLocaleContext
  • SimpleTimeZoneAwareLocaleContext

• parseLocaleValue

  @Nullable protected LocaleSE parseLocaleValue(StringSE localeValue)

  受信 Cookie から取得した特定のロケール値を解析します。

  デフォルトの実装は StringUtils.parseLocale(String) を呼び出し、Locale.toString() 形式と BCP 47 言語タグを受け入れます。

  パラメーター:

  localeValue - 解析するロケール値

  戻り値:

  対応する Locale インスタンス

  導入:

  4.3

  関連事項:

  • StringUtils.parseLocale(String)

• toLocaleValue

  protected StringSE toLocaleValue(LocaleSE locale)

  指定されたロケールを、Cookie に含めるためのテキスト値としてレンダリングします。

  デフォルトの実装では、"languageTagCompliant" 構成プロパティに応じて、Locale.toString() または Locale.toLanguageTag() が呼び出されます。

  パラメーター:

  locale - 文字列に変換するロケール

  戻り値:

  指定されたロケールの文字列表現

  導入:

  4.3

  関連事項:

  • isLanguageTagCompliant()

• determineDefaultLocale

  @DeprecatedSE(since="6.0") protected LocaleSE determineDefaultLocale(HttpServletRequestEE request)

  使用すべきではありません。

  6.0 現在、setDefaultLocaleFunction(Function) を推奨

  ロケール Cookie が見つからなかった場合に呼び出される、指定されたリクエストのデフォルトロケールを決定します。

  デフォルトの実装は、構成されたデフォルトロケールを返します。それ以外の場合は、リクエストの Accept-Language ヘッダーロケールまたはサーバーのデフォルトロケールにフォールバックします。

  パラメーター:

  request - ロケールを解決するためのリクエスト

  戻り値:

  デフォルトのロケール (非 null)

  関連事項:

  • AbstractLocaleResolver.setDefaultLocale(java.util.Locale)
  • ServletRequest.getLocale()EE

• determineDefaultTimeZone

  @DeprecatedSE(since="6.0") @Nullable protected TimeZoneSE determineDefaultTimeZone(HttpServletRequestEE request)

  使用すべきではありません。

  6.0 現在、setDefaultTimeZoneFunction(Function) を推奨

  指定されたリクエストのデフォルトのタイムゾーンを決定します。ロケール Cookie が見つからなかった場合に呼び出されます。

  デフォルトの実装は、構成されたデフォルトのタイムゾーン（存在する場合）を返し、そうでない場合は null を返します。

  パラメーター:

  request - タイムゾーンを解決するためのリクエスト

  戻り値:

  デフォルトのタイムゾーン (または定義されていない場合は null )

  関連事項:

  • AbstractLocaleContextResolver.setDefaultTimeZone(java.util.TimeZone)