クラス RequestContext

メソッドの詳細

• getRequest

  protected final jakarta.servlet.http.HttpServletRequest getRequest()

  基になる HttpServletRequest を返します。このパッケージ内の協力クラスのみを対象としています。

• getServletContext

  protected final @Nullable jakarta.servlet.ServletContext getServletContext()

  基になる ServletContext を返します。このパッケージ内の協力クラスのみを対象としています。

• getWebApplicationContext

  public final WebApplicationContext getWebApplicationContext()

  現在の WebApplicationContext を返します。

• getModel

  public final @Nullable MapSE<StringSE,ObjectSE> getModel()

  この RequestContext がカプセル化するモデルマップがあれば、それを返します。

  戻り値:

  移入されたモデルマップ、または使用可能な場合は null 

• getMessageSource

  public MessageSource getMessageSource()

  使用する MessageSource (通常は現在の WebApplicationContext) を返します。

  メモ: 6.2 時点では、このメソッドは非最終的であるため、オーバーライド可能です。

• getLocale

  public LocaleSE getLocale()

  現在のロケールを返します（リクエストロケールにフォールバックします。null は決してありません）。

  通常、DispatcherServlet の LocaleResolver から取得されます。JSTL のロケール属性のフォールバックチェックも含まれます。

  メモ: 6.2 時点では、このメソッドは非最終的であるため、オーバーライド可能です。

  関連事項:

  • RequestContextUtils.getLocale(HttpServletRequest)

• getTimeZone

  public @Nullable TimeZoneSE getTimeZone()

  現在の TimeZone（またはリクエストから導出できない場合は null）を返します。

  通常、DispatcherServlet の LocaleContextResolver から取得されます。JSTL の TimeZone 属性のフォールバックチェックも含まれます。

  関連事項:

  • RequestContextUtils.getTimeZone(HttpServletRequest)

• getFallbackLocale

  protected LocaleSE getFallbackLocale()

  このコンテキストのフォールバックロケールを決定します。

  デフォルトの実装では、リクエスト、セッション、アプリケーションのスコープで JSTL ロケール属性をチェックします。見つからない場合は、HttpServletRequest.getLocale() を返します。

  戻り値:

  フォールバックロケール (非 null)

  関連事項:

  • ServletRequest.getLocale()

• getFallbackTimeZone

  protected @Nullable TimeZoneSE getFallbackTimeZone()

  このコンテキストのフォールバックタイムゾーンを決定します。

  デフォルトの実装では、リクエスト、セッション、アプリケーションスコープの JSTL タイムゾーン属性をチェックします。見つからない場合は null を返します。

  戻り値:

  フォールバックタイムゾーン (リクエストから派生するものがない場合は null )

• changeLocale

  public void changeLocale(LocaleSE locale)

  現在のロケールを指定されたロケールに変更し、構成された LocaleResolver を通じて新しいロケールを保存します。

  パラメーター:

  locale - 新しいロケール

  関連事項:

  • LocaleResolver.setLocale(HttpServletRequest, HttpServletResponse, Locale)
  • changeLocale(java.util.Locale, java.util.TimeZone)

• changeLocale

  public void changeLocale(LocaleSE locale, TimeZoneSE timeZone)

  現在のロケールを指定されたロケールとタイムゾーンコンテキストに変更し、構成された LocaleResolver を通じて新しいロケールコンテキストを保存します。

  パラメーター:

  locale - 新しいロケール

  timeZone - 新しいタイムゾーン

  関連事項:

  • LocaleContextResolver.setLocaleContext(HttpServletRequest, HttpServletResponse, LocaleContext)
  • SimpleTimeZoneAwareLocaleContext

• setDefaultHtmlEscape

  public void setDefaultHtmlEscape(boolean defaultHtmlEscape)

  この RequestContext のスコープで、メッセージとエラーのデフォルトの HTML エスケープを（非）有効にします。

  デフォルトは、アプリケーション全体の設定 (web.xml の "defaultHtmlEscape" コンテキストパラメーター) です。

  関連事項:

  • WebUtils.getDefaultHtmlEscape(ServletContext)

• isDefaultHtmlEscape

  public boolean isDefaultHtmlEscape()

  デフォルトの HTML エスケープはアクティブですか？ 明示的なデフォルトが指定されていない場合は、false にフォールバックします。

• getDefaultHtmlEscape

  public @Nullable BooleanSE getDefaultHtmlEscape()

  デフォルトが指定されていない場合と明示的な値を区別して、デフォルトの HTML エスケープ設定を返します。

  戻り値:

  デフォルトの HTML エスケープが有効かどうか (null = 明示的なデフォルトなし)

• isResponseEncodedHtmlEscape

  public boolean isResponseEncodedHtmlEscape()

  HTML はデフォルトでレスポンスエンコーディングを使用してエスケープしていますか？ 有効にすると、XML マークアップの重要な文字のみが UTF- * エンコーディングでエスケープされます。

  明示的なデフォルトが指定されていない場合は、true にフォールバックします。

  導入:

  4.1.2

• getResponseEncodedHtmlEscape

  public @Nullable BooleanSE getResponseEncodedHtmlEscape()

  HTML エスケープ設定のレスポンスエンコーディングの使用に関するデフォルト設定を返し、デフォルトが指定されていない場合と明示的な値を区別します。

  戻り値:

  レスポンスエンコーディング HTML エスケープのデフォルトの使用が有効かどうか (null = 明示的なデフォルトなし)

  導入:

  4.1.2

• setUrlPathHelper

  @DeprecatedSE(since="7.0", forRemoval=true) public void setUrlPathHelper(UrlPathHelper urlPathHelper)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。

  コンテキストパスとリクエスト URI のデコードに使用する UrlPathHelper を設定します。共有 UrlPathHelper インスタンスを渡すために使用できます。

  デフォルトの UrlPathHelper は常に使用可能です。

• getUrlPathHelper

  @DeprecatedSE(since="7.0", forRemoval=true) public UrlPathHelper getUrlPathHelper()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。

  コンテキストパスに使用される UrlPathHelper を返し、URI のデコードをリクエストします。現在の UrlPathHelper の構成に使用できます。

  デフォルトの UrlPathHelper は常に使用可能です。

• getRequestDataValueProcessor

  public @Nullable RequestDataValueProcessor getRequestDataValueProcessor()

  WebApplicationContext から "requestDataValueProcessor" という名前で取得して使用する RequestDataValueProcessor インスタンスを返します。または、一致する Bean が見つからなかった場合は null。

• getContextPath

  public StringSE getContextPath()

  元のリクエストのコンテキストパス、つまり現在の Web アプリケーションを示すパスを返します。これは、アプリケーション内の他のリソースへのリンクを構築できます。

  デコード用の UrlPathHelper へのデリゲート。

  関連事項:

  • HttpServletRequest.getContextPath()
  • getUrlPathHelper()

• getContextUrl

  public StringSE getContextUrl(StringSE relativeUrl)

  指定された相対 URL のコンテキスト認識 URl を返します。

  パラメーター:

  relativeUrl - 相対 URL 部分

  戻り値:

  絶対パスでサーバーを指す URL (また、それに応じて URL エンコードされます)

• getContextUrl

  public StringSE getContextUrl(StringSE relativeUrl, MapSE<StringSE,?> params)

  プレースホルダー（中括弧 {} の名前付きキー）を使用して、指定された相対 URL のコンテキスト認識 URl を返します。例: 相対 URL foo/{bar}?spam={spam} とパラメーターマップ {bar=baz,spam=nuts} を送信すると、結果は [contextpath]/foo/baz?spam=nuts になります。

  パラメーター:

  relativeUrl - 相対 URL 部分

  params - URL のプレースホルダーとして挿入するパラメーターのマップ

  戻り値:

  絶対パスでサーバーを指す URL (また、それに応じて URL エンコードされます)

• getPathToServlet

  public StringSE getPathToServlet()

  元のリクエストのコンテキストパスとサーブレットパスを含む現在のサーブレット内の URL マッピングへのパスを返します。これは、スタイル "/main/*" のサーブレットマッピングが使用されるアプリケーション内の他のリソースへのリンクを構築できます。

  UrlPathHelper にデリゲートして、コンテキストとサーブレットパスを決定します。

• getRequestUri

  public StringSE getRequestUri()

  元のリクエストのリクエスト URI、つまりパラメーターなしで呼び出された URL を返します。これは、おそらく元のクエリ文字列と組み合わせて、HTML フォームアクションターゲットとして特に役立ちます。

  デコード用の UrlPathHelper へのデリゲート。

  関連事項:

  • getQueryString()
  • UrlPathHelper.getOriginatingRequestUri(HttpServletRequest)
  • getUrlPathHelper()

• getQueryString

  public StringSE getQueryString()

  現在のリクエストのクエリ文字列、つまりリクエストパスの後の部分を返します。これは、元のリクエスト URI と組み合わせて HTML フォームアクションターゲットを構築する場合に特に便利です。

  デコード用の UrlPathHelper へのデリゲート。

  関連事項:

  • getRequestUri()
  • UrlPathHelper.getOriginatingQueryString(HttpServletRequest)
  • getUrlPathHelper()

• getMessage

  public StringSE getMessage(StringSE code, StringSE defaultMessage)

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  defaultMessage - 検索が失敗した場合に返す文字列

  戻り値:

  メッセージ

• getMessage

  public StringSE getMessage(StringSE code, ObjectSE @Nullable [] args, StringSE defaultMessage)

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - メッセージの引数、または存在しない場合は null 

  defaultMessage - 検索が失敗した場合に返す文字列

  戻り値:

  メッセージ

• getMessage

  public StringSE getMessage(StringSE code, @Nullable ListSE<?> args, StringSE defaultMessage)

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - リストとしてのメッセージの引数。存在しない場合は null 

  defaultMessage - 検索が失敗した場合に返す文字列

  戻り値:

  メッセージ

• getMessage

  public StringSE getMessage(StringSE code, ObjectSE @Nullable [] args, StringSE defaultMessage, boolean htmlEscape)

  指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - メッセージの引数、または存在しない場合は null 

  defaultMessage - 検索が失敗した場合に返す文字列

  htmlEscape - メッセージを HTML エスケープする必要がある場合

  戻り値:

  メッセージ

• getMessage

  public StringSE getMessage(StringSE code) throws NoSuchMessageException

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getMessage

  public StringSE getMessage(StringSE code, ObjectSE @Nullable [] args) throws NoSuchMessageException

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - メッセージの引数、または存在しない場合は null 

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getMessage

  public StringSE getMessage(StringSE code, @Nullable ListSE<?> args) throws NoSuchMessageException

  "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - リストとしてのメッセージの引数。存在しない場合は null 

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getMessage

  public StringSE getMessage(StringSE code, ObjectSE @Nullable [] args, boolean htmlEscape) throws NoSuchMessageException

  指定されたコードのメッセージを取得します。

  パラメーター:

  code - メッセージのコード

  args - メッセージの引数、または存在しない場合は null 

  htmlEscape - メッセージを HTML エスケープする必要がある場合

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getMessage

  public StringSE getMessage(MessageSourceResolvable resolvable) throws NoSuchMessageException

  "defaultHtmlEscape" 設定を使用して、指定された MessageSourceResolvable (たとえば、ObjectError インスタンス) を取得します。

  パラメーター:

  resolvable - MessageSourceResolvable

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getMessage

  public StringSE getMessage(MessageSourceResolvable resolvable, boolean htmlEscape) throws NoSuchMessageException

  指定された MessageSourceResolvable (たとえば、ObjectError インスタンス) を取得します。

  パラメーター:

  resolvable - MessageSourceResolvable

  htmlEscape - メッセージを HTML エスケープする必要がある場合

  戻り値:

  メッセージ

  例外:

  NoSuchMessageException - 見つからない場合

• getErrors

  public @Nullable Errors getErrors(StringSE name)

  "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの Errors インスタンスを取得します。

  パラメーター:

  name - バインドオブジェクトの名前

  戻り値:

  Errors インスタンス、または見つからない場合は null 

• getErrors

  public @Nullable Errors getErrors(StringSE name, boolean htmlEscape)

  指定されたバインドオブジェクトの Errors インスタンスを取得します。

  パラメーター:

  name - バインドオブジェクトの名前

  htmlEscape - 自動 HTML エスケープを使用して Errors インスタンスを作成しますか？

  戻り値:

  Errors インスタンス、または見つからない場合は null 

• getModelObject

  protected @Nullable ObjectSE getModelObject(StringSE modelName)

  指定されたモデル名のモデルオブジェクトを、モデルまたはリクエスト属性から取得します。

  パラメーター:

  modelName - モデルオブジェクトの名前

  戻り値:

  モデルオブジェクト

• getBindStatus

  public BindStatus getBindStatus(StringSE path) throws IllegalStateExceptionSE

  "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。

  パラメーター:

  path - 値とエラーが解決される Bean とプロパティパス (たとえば、"person.age" )

  戻り値:

  新しい BindStatus インスタンス

  例外:

  IllegalStateExceptionSE - 対応する Errors オブジェクトが見つからない場合

• getBindStatus

  public BindStatus getBindStatus(StringSE path, boolean htmlEscape) throws IllegalStateExceptionSE

  "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。

  パラメーター:

  path - 値とエラーが解決される Bean とプロパティパス (たとえば、"person.age" )

  htmlEscape - 自動 HTML エスケープ付きの BindStatus を作成しますか？

  戻り値:

  新しい BindStatus インスタンス

  例外:

  IllegalStateExceptionSE - 対応する Errors オブジェクトが見つからない場合