メソッドの詳細

• method

  @Nullable
  default HttpMethod method()

  HTTP メソッドを取得します。

  戻り値:

  HttpMethod 列挙値としての HTTP メソッド、または解決できない場合は null (たとえば非標準の HTTP メソッドの場合)

• methodName

  java.lang.String methodName()

  HTTP メソッドの名前を取得します。

  戻り値:

  文字列としての HTTP メソッド

• uri

  java.net.URI uri()

  リクエスト URI を取得します。

• uriBuilder

  UriBuilder uriBuilder()

  この ServerRequest に関連付けられた URI から UriBuilderComponents を取得します。

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

  戻り値:

  URI ビルダー

• path

  default java.lang.String path()

  リクエストパスを取得します。

• pathContainer

  default PathContainer pathContainer()

  リクエストパスを PathContainer として取得します。

• headers

  ServerRequest.Headers headers()

  このリクエストのヘッダーを取得します。

• cookies

  MultiValueMap<java.lang.String,HttpCookie> cookies()

  このリクエストの Cookie を取得します。

• remoteAddress

  java.util.Optional<java.net.InetSocketAddress> remoteAddress()

  可能な場合、このリクエストが接続されているリモートアドレスを取得します。

  導入:

  5.1

• messageReaders

  java.util.List<HttpMessageReader<?>> messageReaders()

  このリクエストの本文の変換に使用されるリーダーを取得します。

  導入:

  5.1

• body

  <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor)

  指定された BodyExtractor で本体を抽出します。

  型パラメーター:

  T - 返される本体の型

  パラメーター:

  extractor - リクエストから読み取る BodyExtractor 

  戻り値:

  抽出されたボディ

  関連事項:

  body(BodyExtractor, Map)

• body

  <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor,
             java.util.Map<java.lang.String,java.lang.Object> hints)

  指定された BodyExtractor とヒントを使用してボディを抽出します。

  型パラメーター:

  T - 返される本体の型

  パラメーター:

  extractor - リクエストから読み取る BodyExtractor 

  hints - ボディ抽出のカスタマイズに使用する Jackson2CodecSupport.JSON_VIEW_HINT などのヒントのマップ

  戻り値:

  抽出されたボディ

• bodyToMono

  <T> reactor.core.publisher.Mono<T> bodyToMono(java.lang.Class<? extends T> elementClass)

  本体を Mono に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementClass - Mono の要素のクラス

  戻り値:

  mono としての本体

• bodyToMono

  <T> reactor.core.publisher.Mono<T> bodyToMono(ParameterizedTypeReference<T> typeReference)

  本体を Mono に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  typeReference - 予期されるレスポンスリクエスト型を説明する型参照

  戻り値:

  指定された型 T の本体を含む mono

• bodyToFlux

  <T> reactor.core.publisher.Flux<T> bodyToFlux(java.lang.Class<? extends T> elementClass)

  本体を Flux に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementClass - Flux の要素のクラス

  戻り値:

  flux としての本体

• bodyToFlux

  <T> reactor.core.publisher.Flux<T> bodyToFlux(ParameterizedTypeReference<T> typeReference)

  本体を Flux に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  typeReference - 予想されるリクエスト本文の型を説明する型参照

  戻り値:

  指定された型 T の本体を含む flux

• attribute

  default java.util.Optional<java.lang.Object> attribute(java.lang.String name)

  リクエスト属性値が存在する場合は取得します。

  パラメーター:

  name - 属性名

  戻り値:

  属性値

• attributes

  java.util.Map<java.lang.String,java.lang.Object> attributes()

  リクエスト属性の可変マップを取得します。

  戻り値:

  リクエスト属性

• queryParam

  default java.util.Optional<java.lang.String> queryParam(java.lang.String name)

  存在する場合、指定された名前を持つ最初のクエリパラメーターを取得します。

  パラメーター:

  name - パラメーター名

  戻り値:

  パラメーター値

• queryParams

  MultiValueMap<java.lang.String,java.lang.String> queryParams()

  このリクエストのすべてのクエリパラメーターを取得します。

• pathVariable

  default java.lang.String pathVariable(java.lang.String name)

  指定された名前のパス変数があれば、それを取得します。

  パラメーター:

  name - 変数名

  戻り値:

  変数値

  例外:

  java.lang.IllegalArgumentException - 指定された名前のパス変数がない場合

• pathVariables

  java.util.Map<java.lang.String,java.lang.String> pathVariables()

  このリクエストのすべてのパス変数を取得します。

• session

  reactor.core.publisher.Mono<WebSession> session()

  このリクエストの Web セッションを取得します。

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

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

• principal

  reactor.core.publisher.Mono<? extends java.security.Principal> principal()

  リクエストに対して認証されたユーザーを取得します（存在する場合）。

• formData

  reactor.core.publisher.Mono<MultiValueMap<java.lang.String,java.lang.String>> formData()

  Content-Type が "application/x-www-form-urlencoded" の場合はリクエストの本文からフォームデータを取得し、それ以外の場合は空のマップを取得します。

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

• multipartData

  reactor.core.publisher.Mono<MultiValueMap<java.lang.String,Part>> multipartData()

  Content-Type が "multipart/form-data" の場合はマルチパートリクエストのパーツを取得し、それ以外の場合は空のマップを取得します。

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

• exchange

  ServerWebExchange exchange()

  このリクエストのベースとなる Web エクスチェンジを取得します。

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

  導入:

  5.1

• create

  static ServerRequest create(ServerWebExchange exchange,
                              java.util.List<HttpMessageReader<?>> messageReaders)

  指定された ServerWebExchange およびメッセージリーダーに基づいて新しい ServerRequest を作成します。

  パラメーター:

  exchange - 交換

  messageReaders - メッセージリーダー

  戻り値:

  作成された ServerRequest

• from

  static ServerRequest.Builder from(ServerRequest other)

  指定されたリクエストのステータス、ヘッダー、Cookie を使用してビルダーを作成します。

  パラメーター:

  other - ステータス、ヘッダー、Cookie をコピーするレスポンス

  戻り値:

  作成されたビルダー

  導入:

  5.1