クラス ServerRequestWrapper
java.lang.ObjectSE
org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- 実装されたすべてのインターフェース:
ServerRequest
handler filter function
のリクエストを適応させるためにサブクラス化できる ServerRequest
インターフェースの実装。すべてのメソッドは、デフォルトでラップされたリクエストを呼び出すように設定されています。- 導入:
- 5.0
- 作成者:
- Arjen Poutsma
ネストされたクラスのサマリー
ネストされたクラスインターフェース org.springframework.web.reactive.function.server.ServerRequest から継承されたネストクラス / インターフェース
ServerRequest.Builder, ServerRequest.Headers
コンストラクターのサマリー
コンストラクターコンストラクター説明ServerRequestWrapper
(ServerRequest delegate) 指定されたリクエストをラップする新しいServerRequestWrapper
を作成します。メソッドのサマリー
修飾子と型メソッド説明リクエスト属性値が存在する場合は取得します。リクエスト属性の可変マップを取得します。<T> T
body
(BodyExtractor<T, ? super ServerHttpRequest> extractor) 指定されたBodyExtractor
で本体を抽出します。<T> T
body
(BodyExtractor<T, ? super ServerHttpRequest> extractor, MapSE<StringSE, ObjectSE> hints) 指定されたBodyExtractor
とヒントを使用してボディを抽出します。<T> reactor.core.publisher.Flux<T>
bodyToFlux
(ClassSE<? extends T> elementClass) 本体をFlux
に抽出します。<T> reactor.core.publisher.Flux<T>
bodyToFlux
(ParameterizedTypeReference<T> typeReference) 本体をFlux
に抽出します。<T> reactor.core.publisher.Mono<T>
bodyToMono
(ClassSE<? extends T> elementClass) 本体をMono
に抽出します。<T> reactor.core.publisher.Mono<T>
bodyToMono
(ParameterizedTypeReference<T> typeReference) 本体をMono
に抽出します。cookies()
このリクエストの Cookie を取得します。exchange()
このリクエストのベースとなる Web エクスチェンジを取得します。reactor.core.publisher.Mono<MultiValueMap<StringSE,
StringSE>> formData()
Content-Type が"application/x-www-form-urlencoded"
の場合はリクエストの本文からフォームデータを取得し、それ以外の場合は空のマップを取得します。headers()
このリクエストのヘッダーを取得します。このリクエストが接続されているローカルアドレスを取得します(利用可能な場合)。このリクエストの本文の変換に使用されるリーダーを取得します。method()
HTTP メソッドを取得します。使用すべきではありません。reactor.core.publisher.Mono<MultiValueMap<StringSE,
Part>> Content-Type が"multipart/form-data"
の場合はマルチパートリクエストのパーツを取得し、それ以外の場合は空のマップを取得します。path()
リクエストパスを取得します。使用すべきではありません。pathVariable
(StringSE name) 指定された名前のパス変数があれば、それを取得します。このリクエストのすべてのパス変数を取得します。reactor.core.publisher.Mono<? extends PrincipalSE>
リクエストに対して認証されたユーザーを取得します(存在する場合)。queryParam
(StringSE name) 存在する場合、指定された名前を持つ最初のクエリパラメーターを取得します。このリクエストのすべてのクエリパラメーターを取得します。可能な場合、このリクエストが接続されているリモートアドレスを取得します。request()
ラップされたリクエストを返します。リクエストパスをPathContainer
として取得します。reactor.core.publisher.Mono<WebSession>
session()
このリクエストの Web セッションを取得します。uri()
リクエスト URI を取得します。このServerRequest
に関連付けられた URI からUriBuilderComponents
を取得します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.reactive.function.server.ServerRequest から継承されたメソッド
checkNotModified, checkNotModified, checkNotModified
コンストラクターの詳細
ServerRequestWrapper
指定されたリクエストをラップする新しいServerRequestWrapper
を作成します。- パラメーター:
delegate
- ラップするリクエスト
メソッドの詳細
request
ラップされたリクエストを返します。method
インターフェースからコピーされた説明:ServerRequest
HTTP メソッドを取得します。- 次で指定:
- インターフェース
ServerRequest
のmethod
methodName
使用すべきではありません。インターフェースからコピーされた説明:ServerRequest
HTTP メソッドの名前を取得します。- 次で指定:
- インターフェース
ServerRequest
のmethodName
- 戻り値:
- 文字列としての HTTP メソッド
uri
インターフェースからコピーされた説明:ServerRequest
リクエスト URI を取得します。- 次で指定:
- インターフェース
ServerRequest
のuri
uriBuilder
インターフェースからコピーされた説明:ServerRequest
このServerRequest
に関連付けられた URI からUriBuilderComponents
を取得します。注意 : 5.1 以降、このメソッドは、クライアントが発信したアドレスを指定する
"Forwarded"
および"X-Forwarded-*"
ヘッダーを無視します。ForwardedHeaderFilter
を使用して、このようなヘッダーを抽出して使用するか、破棄することを検討してください。- 次で指定:
- インターフェース
ServerRequest
のuriBuilder
- 戻り値:
- URI ビルダー
path
インターフェースからコピーされた説明:ServerRequest
リクエストパスを取得します。- 次で指定:
- インターフェース
ServerRequest
のpath
pathContainer
使用すべきではありません。インターフェースからコピーされた説明:ServerRequest
リクエストパスをPathContainer
として取得します。- 次で指定:
- インターフェース
ServerRequest
のpathContainer
requestPath
インターフェースからコピーされた説明:ServerRequest
リクエストパスをPathContainer
として取得します。- 次で指定:
- インターフェース
ServerRequest
のrequestPath
headers
インターフェースからコピーされた説明:ServerRequest
このリクエストのヘッダーを取得します。- 次で指定:
- インターフェース
ServerRequest
のheaders
cookies
インターフェースからコピーされた説明:ServerRequest
このリクエストの Cookie を取得します。- 次で指定:
- インターフェース
ServerRequest
のcookies
remoteAddress
インターフェースからコピーされた説明:ServerRequest
可能な場合、このリクエストが接続されているリモートアドレスを取得します。- 次で指定:
- インターフェース
ServerRequest
のremoteAddress
localAddress
インターフェースからコピーされた説明:ServerRequest
このリクエストが接続されているローカルアドレスを取得します(利用可能な場合)。- 次で指定:
- インターフェース
ServerRequest
のlocalAddress
messageReaders
インターフェースからコピーされた説明:ServerRequest
このリクエストの本文の変換に使用されるリーダーを取得します。- 次で指定:
- インターフェース
ServerRequest
のmessageReaders
body
インターフェースからコピーされた説明:ServerRequest
指定されたBodyExtractor
で本体を抽出します。- 次で指定:
- インターフェース
ServerRequest
のbody
- 型パラメーター:
T
- 返される本体の型- パラメーター:
extractor
- リクエストから読み取るBodyExtractor
- 戻り値:
- 抽出されたボディ
- 関連事項:
body
public <T> T body(BodyExtractor<T, ? super ServerHttpRequest> extractor, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:ServerRequest
指定されたBodyExtractor
とヒントを使用してボディを抽出します。- 次で指定:
- インターフェース
ServerRequest
のbody
- 型パラメーター:
T
- 返される本体の型- パラメーター:
extractor
- リクエストから読み取るBodyExtractor
hints
- ボディ抽出のカスタマイズに使用するJackson2CodecSupport.JSON_VIEW_HINT
などのヒントのマップ- 戻り値:
- 抽出されたボディ
bodyToMono
インターフェースからコピーされた説明:ServerRequest
本体をMono
に抽出します。- 次で指定:
- インターフェース
ServerRequest
のbodyToMono
- 型パラメーター:
T
- 要素型- パラメーター:
elementClass
-Mono
の要素のクラス- 戻り値:
- mono としての本体
bodyToMono
インターフェースからコピーされた説明:ServerRequest
本体をMono
に抽出します。- 次で指定:
- インターフェース
ServerRequest
のbodyToMono
- 型パラメーター:
T
- 要素型- パラメーター:
typeReference
- 予期されるレスポンスリクエスト型を説明する型参照- 戻り値:
- 指定された型
T
の本体を含む mono
bodyToFlux
インターフェースからコピーされた説明:ServerRequest
本体をFlux
に抽出します。- 次で指定:
- インターフェース
ServerRequest
のbodyToFlux
- 型パラメーター:
T
- 要素型- パラメーター:
elementClass
-Flux
の要素のクラス- 戻り値:
- flux としての本体
bodyToFlux
インターフェースからコピーされた説明:ServerRequest
本体をFlux
に抽出します。- 次で指定:
- インターフェース
ServerRequest
のbodyToFlux
- 型パラメーター:
T
- 要素型- パラメーター:
typeReference
- 予想されるリクエスト本文の型を説明する型参照- 戻り値:
- 指定された型
T
の本体を含む flux
attribute
インターフェースからコピーされた説明:ServerRequest
リクエスト属性値が存在する場合は取得します。- 次で指定:
- インターフェース
ServerRequest
のattribute
- パラメーター:
name
- 属性名- 戻り値:
- 属性値
attributes
インターフェースからコピーされた説明:ServerRequest
リクエスト属性の可変マップを取得します。- 次で指定:
- インターフェース
ServerRequest
のattributes
- 戻り値:
- リクエスト属性
queryParam
インターフェースからコピーされた説明:ServerRequest
存在する場合、指定された名前を持つ最初のクエリパラメーターを取得します。- 次で指定:
- インターフェース
ServerRequest
のqueryParam
- パラメーター:
name
- パラメーター名- 戻り値:
- パラメーター値
queryParams
インターフェースからコピーされた説明:ServerRequest
このリクエストのすべてのクエリパラメーターを取得します。- 次で指定:
- インターフェース
ServerRequest
のqueryParams
pathVariable
インターフェースからコピーされた説明:ServerRequest
指定された名前のパス変数があれば、それを取得します。- 次で指定:
- インターフェース
ServerRequest
のpathVariable
- パラメーター:
name
- 変数名- 戻り値:
- 変数値
pathVariables
インターフェースからコピーされた説明:ServerRequest
このリクエストのすべてのパス変数を取得します。- 次で指定:
- インターフェース
ServerRequest
のpathVariables
session
インターフェースからコピーされた説明:ServerRequest
このリクエストの Web セッションを取得します。クライアントからリクエストされたセッション ID と一致するか、クライアントがインスタンスを指定しなかったため、または基になるセッションが期限切れになったために新しいセッション ID でインスタンスを返すことが常に保証されています。
このメソッドを使用しても、セッションは自動的には作成されません。
- 次で指定:
- インターフェース
ServerRequest
のsession
principal
インターフェースからコピーされた説明:ServerRequest
リクエストに対して認証されたユーザーを取得します(存在する場合)。- 次で指定:
- インターフェース
ServerRequest
のprincipal
formData
インターフェースからコピーされた説明:ServerRequest
Content-Type が"application/x-www-form-urlencoded"
の場合はリクエストの本文からフォームデータを取得し、それ以外の場合は空のマップを取得します。注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の
MultiValueMap
がキャッシュされるため、このメソッドを複数回呼び出しても安全です。- 次で指定:
- インターフェース
ServerRequest
のformData
multipartData
インターフェースからコピーされた説明:ServerRequest
Content-Type が"multipart/form-data"
の場合はマルチパートリクエストのパーツを取得し、それ以外の場合は空のマップを取得します。注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の
MultiValueMap
がキャッシュされるため、このメソッドを複数回呼び出しても安全です。- 次で指定:
- インターフェース
ServerRequest
のmultipartData
exchange
インターフェースからコピーされた説明:ServerRequest
このリクエストのベースとなる Web エクスチェンジを取得します。メモ: (
ServerRequest
およびServerResponse
で提供されるメソッドを使用する代わりに)交換を直接操作すると、不規則な結果が生じる可能性があります。- 次で指定:
- インターフェース
ServerRequest
のexchange