クラス RequestContext
java.lang.ObjectSE
org.springframework.web.reactive.result.view.RequestContext
使用する
MessageSource
、現在のロケール、バインディングエラーなどのリクエスト固有の状態のコンテキストホルダー。ローカライズされたメッセージとエラーインスタンスへの簡単なアクセスを提供します。ビューの説明、および FreeMarker テンプレートとタグライブラリ内での使用に適しています。
手動でインスタンス化することも、AbstractView の "requestContextAttribute" プロパティを介してモデル属性としてビューに自動的に公開することもできます。
- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
コンストラクターコンストラクター説明RequestContext
(ServerWebExchange exchange, MapSE<StringSE, ObjectSE> model, MessageSource messageSource) RequestContext
(ServerWebExchange exchange, MapSE<StringSE, ObjectSE> model, MessageSource messageSource, RequestDataValueProcessor dataValueProcessor) メソッドのサマリー
修飾子と型メソッド説明void
changeLocale
(LocaleSE locale) 現在のロケールを指定されたロケールに変更します。void
changeLocale
(LocaleSE locale, TimeZoneSE timeZone) 現在のロケールを指定されたロケールとタイムゾーンのコンテキストに変更します。getBindStatus
(StringSE path) "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。getBindStatus
(StringSE path, boolean htmlEscape) "defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。現在の Web アプリケーションのコンテキストパスを返します。getContextUrl
(StringSE relativeUrl) 指定された相対 URL のコンテキスト認識 URl を返します。getContextUrl
(StringSE relativeUrl, MapSE<StringSE, ?> params) プレースホルダー付きの指定された相対 URL のコンテキスト認識 URl- 中括弧{}
付きの名前付きキーを返します。デフォルトが指定されていない場合と明示的な値を区別して、デフォルトの HTML エスケープ設定を返します。"defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの Errors インスタンスを取得します。指定されたバインドオブジェクトの Errors インスタンスを取得します。protected final ServerWebExchange
final LocaleSE
現在のロケールを返します。getMessage
(StringSE code) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(StringSE code, ObjectSE[] args) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(StringSE code, ObjectSE[] args, boolean htmlEscape) 指定されたコードのメッセージを取得します。getMessage
(StringSE code, ObjectSE[] args, StringSE defaultMessage) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(StringSE code, ObjectSE[] args, StringSE defaultMessage, boolean htmlEscape) 指定されたコードのメッセージを取得します。getMessage
(StringSE code, StringSE defaultMessage) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(StringSE code, ListSE<?> args) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(StringSE code, ListSE<?> args, StringSE defaultMessage) "defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。getMessage
(MessageSourceResolvable resolvable) 指定された MessageSourceResolvable を取得します(例:getMessage
(MessageSourceResolvable resolvable, boolean htmlEscape) 指定された MessageSourceResolvable を取得します(例:このリクエストで使用中の MessageSource を返します。getModel()
この RequestContext がカプセル化するモデルマップがあれば、それを返します。protected <T> T
getModelObject
(StringSE modelName) 指定されたモデル名のモデルオブジェクトを、モデルまたはリクエスト属性から取得します。現在のリクエストのクエリ文字列を返します。フォームタグライブラリに適用し、URL をリダイレクトするRequestDataValueProcessor
インスタンスを返します。リクエストのリクエストパスを返します。現在の TimeZone を返します。boolean
デフォルトの HTML エスケープはアクティブですか? 明示的なデフォルトが指定されていない場合は、false
にフォールバックします。void
setDefaultHtmlEscape
(boolean defaultHtmlEscape) この RequestContext のスコープで、メッセージとエラーのデフォルトの HTML エスケープを(非)有効にします。
コンストラクターの詳細
RequestContext
public RequestContext(ServerWebExchange exchange, MapSE<StringSE, ObjectSE> model, MessageSource messageSource) RequestContext
public RequestContext(ServerWebExchange exchange, MapSE<StringSE, ObjectSE> model, MessageSource messageSource, @Nullable RequestDataValueProcessor dataValueProcessor)
メソッドの詳細
getExchange
getMessageSource
このリクエストで使用中の MessageSource を返します。getModel
この RequestContext がカプセル化するモデルマップがあれば、それを返します。- 戻り値:
- 移入されたモデルマップ、または使用可能な場合は
null
getLocale
現在のロケールを返します。getTimeZone
現在の TimeZone を返します。changeLocale
現在のロケールを指定されたロケールに変更します。changeLocale
現在のロケールを指定されたロケールとタイムゾーンのコンテキストに変更します。setDefaultHtmlEscape
public void setDefaultHtmlEscape(boolean defaultHtmlEscape) この RequestContext のスコープで、メッセージとエラーのデフォルトの HTML エスケープを(非)有効にします。TODO: 現在、アプリケーション全体の設定はありません...
isDefaultHtmlEscape
public boolean isDefaultHtmlEscape()デフォルトの HTML エスケープはアクティブですか? 明示的なデフォルトが指定されていない場合は、false
にフォールバックします。getDefaultHtmlEscape
デフォルトが指定されていない場合と明示的な値を区別して、デフォルトの HTML エスケープ設定を返します。- 戻り値:
- デフォルトの HTML エスケープが有効かどうか (null = 明示的なデフォルトなし)
getRequestDataValueProcessor
フォームタグライブラリに適用し、URL をリダイレクトするRequestDataValueProcessor
インスタンスを返します。getContextPath
現在の Web アプリケーションのコンテキストパスを返します。これは、アプリケーション内の他のリソースへのリンクを構築できます。ServerHttpRequest.getPath()
へのデリゲート。getContextUrl
指定された相対 URL のコンテキスト認識 URl を返します。- パラメーター:
relativeUrl
- 相対 URL 部分- 戻り値:
- 絶対パスを使用して現在の Web アプリケーションを指す URL も、それに応じて URL エンコードされます
getContextUrl
プレースホルダー付きの指定された相対 URL のコンテキスト認識 URl- 中括弧付きの名前付きキー{}
を返します。例: 相対 URLfoo/{bar}?spam={spam}
およびパラメーターマップ{bar=baz,spam=nuts}
を送信すると、結果は[contextpath]/foo/baz?spam=nuts
になります。- パラメーター:
relativeUrl
- 相対 URL 部分params
- URL のプレースホルダーとして挿入するパラメーターのマップ- 戻り値:
- 絶対パスを使用して現在の Web アプリケーションを指す URL も、それに応じて URL エンコードされます
getRequestPath
リクエストのリクエストパスを返します。これは、HTML フォームアクションターゲットとして、また元のクエリ文字列と組み合わせて使用すると便利です。getQueryString
現在のリクエストのクエリ文字列を返します。これは、元のリクエストパスと組み合わせて HTML フォームアクションターゲットを構築する場合に役立ちます。getMessage
"defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。- パラメーター:
code
- メッセージのコードdefaultMessage
- 検索が失敗した場合に返す文字列- 戻り値:
- メッセージ
getMessage
"defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。- パラメーター:
code
- メッセージのコードargs
- メッセージの引数、または存在しない場合はnull
defaultMessage
- 検索が失敗した場合に返す文字列- 戻り値:
- メッセージ
getMessage
"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
"defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。- パラメーター:
code
- メッセージのコード- 戻り値:
- メッセージ
- 例外:
NoSuchMessageException
- 見つからない場合
getMessage
"defaultHtmlEscape" 設定を使用して、指定されたコードのメッセージを取得します。- パラメーター:
code
- メッセージのコードargs
- メッセージの引数、または存在しない場合はnull
- 戻り値:
- メッセージ
- 例外:
NoSuchMessageException
- 見つからない場合
getMessage
"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
"defaultHtmlEscape" 設定を使用して、指定された MessageSourceResolvable (例: ObjectError インスタンス) を取得します。- パラメーター:
resolvable
- MessageSourceResolvable- 戻り値:
- メッセージ
- 例外:
NoSuchMessageException
- 見つからない場合
getMessage
public StringSE getMessage(MessageSourceResolvable resolvable, boolean htmlEscape) throws NoSuchMessageException 指定された MessageSourceResolvable(ObjectError インスタンスなど)を取得します。- パラメーター:
resolvable
- MessageSourceResolvablehtmlEscape
- メッセージを HTML エスケープする必要がある場合- 戻り値:
- メッセージ
- 例外:
NoSuchMessageException
- 見つからない場合
getErrors
"defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの Errors インスタンスを取得します。- パラメーター:
name
- バインドオブジェクトの名前- 戻り値:
- Errors インスタンス、または見つからない場合は
null
getErrors
指定されたバインドオブジェクトの Errors インスタンスを取得します。- パラメーター:
name
- バインドオブジェクトの名前htmlEscape
- 自動 HTML エスケープを使用して Errors インスタンスを作成しますか?- 戻り値:
- Errors インスタンス、または見つからない場合は
null
getModelObject
指定されたモデル名のモデルオブジェクトを、モデルまたはリクエスト属性から取得します。- パラメーター:
modelName
- モデルオブジェクトの名前- 戻り値:
- モデルオブジェクト
getBindStatus
"defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。- パラメーター:
path
- 値とエラーが解決される Bean とプロパティパス (たとえば "person.age" )- 戻り値:
- 新しい BindStatus インスタンス
- 例外:
IllegalStateExceptionSE
- 対応する Errors オブジェクトが見つからない場合
getBindStatus
"defaultHtmlEscape" 設定を使用して、指定されたバインドオブジェクトの BindStatus を作成します。- パラメーター:
path
- 値とエラーが解決される Bean とプロパティパス (たとえば "person.age" )htmlEscape
- 自動 HTML エスケープ付きの BindStatus を作成しますか?- 戻り値:
- 新しい BindStatus インスタンス
- 例外:
IllegalStateExceptionSE
- 対応する Errors オブジェクトが見つからない場合