パッケージ org.springframework.web.reactive.result.view

クラス RequestContext

java.lang.ObjectSE
org.springframework.web.reactive.result.view.RequestContext
public class RequestContext extends ObjectSE
使用する MessageSource、現在のロケール、バインディングエラーなどのリクエスト固有の状態のコンテキストホルダー。ローカライズされたメッセージとエラーインスタンスへの簡単なアクセスを提供します。

ビューの説明、および FreeMarker テンプレートとタグライブラリ内での使用に適しています。

AbstractView の "requestContextAttribute" プロパティを介して、手動でインスタンス化するか、自動的にビューにモデル属性として公開できます。

導入:
5.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

  • メソッドの詳細

    • getExchange

      protected final ServerWebExchange getExchange()

    • getMessageSource

      public MessageSource getMessageSource()
      このリクエストで使用中の MessageSource を返します。

    • getModel

      @Nullable public MapSE<StringSE,ObjectSE> getModel()
      この RequestContext がカプセル化するモデルマップがあれば、それを返します。
      戻り値:
      移入されたモデルマップ、または使用可能な場合は null 

    • getLocale

      public final LocaleSE getLocale()
      現在のロケールを返します。

    • getTimeZone

      public TimeZoneSE getTimeZone()
      現在の TimeZone を返します。

    • changeLocale

      public void changeLocale(LocaleSE locale)
      現在のロケールを指定されたロケールに変更します。

    • changeLocale

      public void changeLocale(LocaleSE locale, TimeZoneSE timeZone)
      現在のロケールを指定されたロケールとタイムゾーンのコンテキストに変更します。

    • setDefaultHtmlEscape

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

      TODO: 現在、アプリケーション全体の設定はありません...

    • isDefaultHtmlEscape

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

    • getDefaultHtmlEscape

      @Nullable public BooleanSE getDefaultHtmlEscape()
      デフォルトが指定されていない場合と明示的な値を区別して、デフォルトの HTML エスケープ設定を返します。
      戻り値:
      デフォルトの HTML エスケープが有効かどうか (null = 明示的なデフォルトなし)

    • getRequestDataValueProcessor

      @Nullable public RequestDataValueProcessor getRequestDataValueProcessor()
      フォームタグライブラリに適用し、URL をリダイレクトする RequestDataValueProcessor インスタンスを返します。

    • getContextPath

      public StringSE getContextPath()
      現在の Web アプリケーションのコンテキストパスを返します。これは、アプリケーション内の他のリソースへのリンクを構築できます。

      ServerHttpRequest.getPath() へのデリゲート。

    • getContextUrl

      public StringSE getContextUrl(StringSE relativeUrl)
      指定された相対 URL のコンテキスト認識 URl を返します。
      パラメーター:
      relativeUrl - 相対 URL 部分
      戻り値:
      絶対パスを使用して現在の Web アプリケーションを指す 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 のプレースホルダーとして挿入するパラメーターのマップ
      戻り値:
      絶対パスを使用して現在の Web アプリケーションを指す URL も、それに応じて URL エンコードされます

    • getRequestPath

      public StringSE getRequestPath()
      リクエストのリクエストパスを返します。これは、HTML フォームアクションターゲットとして、また元のクエリ文字列と組み合わせて使用すると便利です。

    • getQueryString

      public StringSE getQueryString()
      現在のリクエストのクエリ文字列を返します。これは、元のリクエストパスと組み合わせて HTML フォームアクションターゲットを構築する場合に役立ちます。

    • getMessage

      public StringSE getMessage(StringSE code, StringSE defaultMessage)
      "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。
      パラメーター:
      code - メッセージのコード
      defaultMessage - 検索が失敗した場合に返す文字列
      戻り値:
      メッセージ

    • getMessage

      public StringSE getMessage(StringSE code, @Nullable ObjectSE[] 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, @Nullable ObjectSE[] 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, @Nullable ObjectSE[] 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, @Nullable ObjectSE[] 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

      @Nullable public Errors getErrors(StringSE name)
      "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの Errors インスタンスを取得します。
      パラメーター:
      name - バインドオブジェクトの名前
      戻り値:
      Errors インスタンス、または見つからない場合は null 

    • getErrors

      @Nullable public Errors getErrors(StringSE name, boolean htmlEscape)
      指定されたバインドオブジェクトの Errors インスタンスを取得します。
      パラメーター:
      name - バインドオブジェクトの名前
      htmlEscape - 自動 HTML エスケープを使用して Errors インスタンスを作成しますか？
      戻り値:
      Errors インスタンス、または見つからない場合は null 

    • getModelObject

      @Nullable protected <T> T 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 オブジェクトが見つからない場合