パッケージ org.springframework.web.reactive.function.server.support

クラス ServerRequestWrapper

java.lang.ObjectSE
org.springframework.web.reactive.function.server.support.ServerRequestWrapper
実装されたすべてのインターフェース:
ServerRequest
public class ServerRequestWrapper extends ObjectSE implements ServerRequest
handler filter function のリクエストを適応させるためにサブクラス化できる ServerRequest インターフェースの実装。すべてのメソッドは、デフォルトでラップされたリクエストを呼び出すように設定されています。
導入:
5.0
作成者:
Arjen Poutsma

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

    • ServerRequestWrapper

      public ServerRequestWrapper(ServerRequest delegate)
      指定されたリクエストをラップする新しい ServerRequestWrapper を作成します。
      パラメーター:
      delegate - ラップするリクエスト

  • メソッドの詳細

    • request

      public ServerRequest request()
      ラップされたリクエストを返します。

    • method

      public HttpMethod method()
      インターフェースからコピーされた説明: ServerRequest
      HTTP メソッドを取得します。
      次で指定:
      インターフェース ServerRequest の method 

    • methodName

      @DeprecatedSE public StringSE methodName()
      使用すべきではありません。
      インターフェースからコピーされた説明: ServerRequest
      HTTP メソッドの名前を取得します。
      次で指定:
      インターフェース ServerRequest の methodName 
      戻り値:
      文字列としての HTTP メソッド

    • uri

      public URISE uri()
      インターフェースからコピーされた説明: ServerRequest
      リクエスト URI を取得します。
      次で指定:
      インターフェース ServerRequest の uri 

    • uriBuilder

      public UriBuilder uriBuilder()
      インターフェースからコピーされた説明: ServerRequest
      この ServerRequest に関連付けられた URI から UriBuilderComponents を取得します。

      注意 : 5.1 以降、このメソッドは、クライアントが発信したアドレスを指定する "Forwarded" および "X-Forwarded-*" ヘッダーを無視します。ForwardedHeaderFilter を使用して、このようなヘッダーを抽出して使用するか、破棄することを検討してください。

      次で指定:
      インターフェース ServerRequest の uriBuilder 
      戻り値:
      URI ビルダー

    • path

      public StringSE path()
      インターフェースからコピーされた説明: ServerRequest
      リクエストパスを取得します。
      次で指定:
      インターフェース ServerRequest の path 

    • pathContainer

      @DeprecatedSE public PathContainer pathContainer()
      使用すべきではありません。
      インターフェースからコピーされた説明: ServerRequest
      リクエストパスを PathContainer として取得します。
      次で指定:
      インターフェース ServerRequest の pathContainer 

    • requestPath

      public RequestPath requestPath()
      インターフェースからコピーされた説明: ServerRequest
      リクエストパスを PathContainer として取得します。
      次で指定:
      インターフェース ServerRequest の requestPath 

    • headers

      public ServerRequest.Headers headers()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストのヘッダーを取得します。
      次で指定:
      インターフェース ServerRequest の headers 

    • cookies

      public MultiValueMap<StringSE,HttpCookie> cookies()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストの Cookie を取得します。
      次で指定:
      インターフェース ServerRequest の cookies 

    • remoteAddress

      public OptionalSE<InetSocketAddressSE> remoteAddress()
      インターフェースからコピーされた説明: ServerRequest
      可能な場合、このリクエストが接続されているリモートアドレスを取得します。
      次で指定:
      インターフェース ServerRequest の remoteAddress 

    • localAddress

      public OptionalSE<InetSocketAddressSE> localAddress()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストが接続されているローカルアドレスを取得します（利用可能な場合）。
      次で指定:
      インターフェース ServerRequest の localAddress 

    • messageReaders

      public ListSE<HttpMessageReader<?>> messageReaders()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストの本文の変換に使用されるリーダーを取得します。
      次で指定:
      インターフェース ServerRequest の messageReaders 

    • body

      public <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor)
      インターフェースからコピーされた説明: 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

      public <T> reactor.core.publisher.Mono<T> bodyToMono(ClassSE<? extends T> elementClass)
      インターフェースからコピーされた説明: ServerRequest
      本体を Mono に抽出します。
      次で指定:
      インターフェース ServerRequest の bodyToMono 
      型パラメーター:
      T - 要素型
      パラメーター:
      elementClass - Mono の要素のクラス
      戻り値:
      mono としての本体

    • bodyToMono

      public <T> reactor.core.publisher.Mono<T> bodyToMono(ParameterizedTypeReference<T> typeReference)
      インターフェースからコピーされた説明: ServerRequest
      本体を Mono に抽出します。
      次で指定:
      インターフェース ServerRequest の bodyToMono 
      型パラメーター:
      T - 要素型
      パラメーター:
      typeReference - 予期されるレスポンスリクエスト型を説明する型参照
      戻り値:
      指定された型 T の本体を含む mono

    • bodyToFlux

      public <T> reactor.core.publisher.Flux<T> bodyToFlux(ClassSE<? extends T> elementClass)
      インターフェースからコピーされた説明: ServerRequest
      本体を Flux に抽出します。
      次で指定:
      インターフェース ServerRequest の bodyToFlux 
      型パラメーター:
      T - 要素型
      パラメーター:
      elementClass - Flux の要素のクラス
      戻り値:
      flux としての本体

    • bodyToFlux

      public <T> reactor.core.publisher.Flux<T> bodyToFlux(ParameterizedTypeReference<T> typeReference)
      インターフェースからコピーされた説明: ServerRequest
      本体を Flux に抽出します。
      次で指定:
      インターフェース ServerRequest の bodyToFlux 
      型パラメーター:
      T - 要素型
      パラメーター:
      typeReference - 予想されるリクエスト本文の型を説明する型参照
      戻り値:
      指定された型 T の本体を含む flux

    • bind

      public <T> reactor.core.publisher.Mono<T> bind(ClassSE<T> bindType)
      インターフェースからコピーされた説明: ServerRequest
      このリクエストにバインドして、指定された型のインスタンスを返します。
      次で指定:
      インターフェース ServerRequest の bind 
      型パラメーター:
      T - バインドする型
      パラメーター:
      bindType - このリクエストをバインドするクラスの型
      戻り値:
      bindType の構築されバインドされたインスタンス、またはバインドエラーの場合は BindException のいずれかを含む mono

    • bind

      public <T> reactor.core.publisher.Mono<T> bind(ClassSE<T> bindType, ConsumerSE<WebDataBinder> dataBinderCustomizer)
      インターフェースからコピーされた説明: ServerRequest
      このリクエストにバインドして、指定された型のインスタンスを返します。
      次で指定:
      インターフェース ServerRequest の bind 
      型パラメーター:
      T - バインドする型
      パラメーター:
      bindType - このリクエストをバインドするクラスの型
      dataBinderCustomizer - データバインダーをカスタマイズするために使用されます。たとえば、許可 / 禁止フィールドを設定します。
      戻り値:
      bindType の構築されバインドされたインスタンス、またはバインドエラーの場合は BindException のいずれかを含む mono

    • attribute

      public OptionalSE<ObjectSE> attribute(StringSE name)
      インターフェースからコピーされた説明: ServerRequest
      リクエスト属性値が存在する場合は取得します。
      次で指定:
      インターフェース ServerRequest の attribute 
      パラメーター:
      name - 属性名
      戻り値:
      属性値

    • attributes

      public MapSE<StringSE,ObjectSE> attributes()
      インターフェースからコピーされた説明: ServerRequest
      リクエスト属性の可変マップを取得します。
      次で指定:
      インターフェース ServerRequest の attributes 
      戻り値:
      リクエスト属性

    • queryParam

      public OptionalSE<StringSE> queryParam(StringSE name)
      インターフェースからコピーされた説明: ServerRequest
      存在する場合、指定された名前を持つ最初のクエリパラメーターを取得します。
      次で指定:
      インターフェース ServerRequest の queryParam 
      パラメーター:
      name - パラメーター名
      戻り値:
      パラメーター値

    • queryParams

      public MultiValueMap<StringSE,StringSE> queryParams()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストのすべてのクエリパラメーターを取得します。
      次で指定:
      インターフェース ServerRequest の queryParams 

    • pathVariable

      public StringSE pathVariable(StringSE name)
      インターフェースからコピーされた説明: ServerRequest
      指定された名前のパス変数があれば、それを取得します。
      次で指定:
      インターフェース ServerRequest の pathVariable 
      パラメーター:
      name - 変数名
      戻り値:
      変数値

    • pathVariables

      public MapSE<StringSE,StringSE> pathVariables()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストのすべてのパス変数を取得します。
      次で指定:
      インターフェース ServerRequest の pathVariables 

    • session

      public reactor.core.publisher.Mono<WebSession> session()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストの Web セッションを取得します。

      クライアントからリクエストされたセッション ID と一致するか、クライアントがインスタンスを指定しなかったため、または基になるセッションが期限切れになったために新しいセッション ID でインスタンスを返すことが常に保証されています。

      このメソッドを使用しても、セッションは自動的には作成されません。

      次で指定:
      インターフェース ServerRequest の session 

    • principal

      public reactor.core.publisher.Mono<? extends PrincipalSE> principal()
      インターフェースからコピーされた説明: ServerRequest
      リクエストに対して認証されたユーザーを取得します（存在する場合）。
      次で指定:
      インターフェース ServerRequest の principal 

    • formData

      public reactor.core.publisher.Mono<MultiValueMap<StringSE,StringSE>> formData()
      インターフェースからコピーされた説明: ServerRequest
      Content-Type が "application/x-www-form-urlencoded" の場合はリクエストの本文からフォームデータを取得し、それ以外の場合は空のマップを取得します。

      注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の MultiValueMap がキャッシュされるため、このメソッドを複数回呼び出しても安全です。

      次で指定:
      インターフェース ServerRequest の formData 

    • multipartData

      public reactor.core.publisher.Mono<MultiValueMap<StringSE,Part>> multipartData()
      インターフェースからコピーされた説明: ServerRequest
      Content-Type が "multipart/form-data" の場合はマルチパートリクエストのパーツを取得し、それ以外の場合は空のマップを取得します。

      注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の MultiValueMap がキャッシュされるため、このメソッドを複数回呼び出しても安全です。

      次で指定:
      インターフェース ServerRequest の multipartData 

    • exchange

      public ServerWebExchange exchange()
      インターフェースからコピーされた説明: ServerRequest
      このリクエストのベースとなる Web エクスチェンジを取得します。

      メモ: （ServerRequest および ServerResponse で提供されるメソッドを使用する代わりに）交換を直接操作すると、不規則な結果が生じる可能性があります。

      次で指定:
      インターフェース ServerRequest の exchange