public interface ClientResponse
WebClient
および ExchangeFunction
によって返される HTTP レスポンスを表します。レスポンスステータスとヘッダーへのアクセスを提供し、レスポンス本文を消費するメソッドも提供します。 注意 : WebClient
exchange()
メソッドを介して ClientResponse
へのアクセスが許可されている場合、リソースが確実に解放され、HTTP 接続プールの潜在的な課題を回避するために、常に body または toEntity メソッドのいずれかを使用する必要があります。レスポンスコンテンツが予期されない場合は、bodyToMono(Void.class)
を使用できます。ただし、レスポンスにコンテンツが含まれている場合、接続は閉じられ、プールに戻されないことに注意してください。
修飾子と型 | インターフェースと説明 |
---|---|
static interface | ClientResponse.Builder レスポンスのビルダーを定義します。 |
static interface | ClientResponse.Headers HTTP レスポンスのヘッダーを表します。 |
修飾子と型 | メソッドと説明 |
---|---|
<T> T | body(BodyExtractor<T,? super ClientHttpResponse> extractor) 指定された 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 に抽出します。 |
MultiValueMap<StringSE, ResponseCookie> | cookies() このレスポンスの Cookie を返します。 |
static ClientResponse.Builder | create(HttpStatus statusCode) 指定されたステータスコードで、本文を読み取るためのデフォルトの戦略を使用して、レスポンスビルダーを作成します。 |
static ClientResponse.Builder | create(HttpStatus statusCode, ExchangeStrategies strategies) 指定されたステータスコードと本文を読み取るための戦略を使用して、レスポンスビルダーを作成します。 |
static ClientResponse.Builder | create(HttpStatus statusCode, ListSE<HttpMessageReader<?>> messageReaders) 指定されたステータスコードとメッセージ本文リーダーを使用して、レスポンスビルダーを作成します。 |
static ClientResponse.Builder | from(ClientResponse other) 指定されたレスポンスのステータス、ヘッダー、Cookie を使用してビルダーを作成します。 |
ClientResponse.Headers | headers() このレスポンスのヘッダーを返します。 |
int | rawStatusCode() このレスポンスの(潜在的に非標準の)ステータスコードを返します。 |
HttpStatus | statusCode() このレスポンスのステータスコードを返します。 |
ExchangeStrategies | strategies() このレスポンスの本文を変換するために使用される戦略を返します。 |
<T> reactor.core.publisher.Mono<ResponseEntity<T>> | toEntity(ClassSE<T> bodyType) このレスポンスを遅延 ResponseEntity として返します。 |
<T> reactor.core.publisher.Mono<ResponseEntity<T>> | toEntity(ParameterizedTypeReference<T> typeReference) このレスポンスを遅延 ResponseEntity として返します。 |
<T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> | toEntityList(ClassSE<T> elementType) このレスポンスを ResponseEntity の遅延リストとして返します。 |
<T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> | toEntityList(ParameterizedTypeReference<T> typeReference) このレスポンスを ResponseEntity の遅延リストとして返します。 |
HttpStatus statusCode()
IllegalArgumentExceptionSE
- 不明な HTTP ステータスコードの場合 HttpStatus.valueOf(int)
int rawStatusCode()
statusCode()
, HttpStatus.resolve(int)
ClientResponse.Headers headers()
MultiValueMap<StringSE,ResponseCookie> cookies()
ExchangeStrategies strategies()
<T> T body(BodyExtractor<T,? super ClientHttpResponse> extractor)
BodyExtractor
で本体を抽出します。T
- 返される本体の型 extractor
- レスポンスから読み取る BodyExtractor
<T> reactor.core.publisher.Mono<T> bodyToMono(ClassSE<? extends T> elementClass)
Mono
に抽出します。T
- 要素型 elementClass
- Mono
の要素のクラス T
の本体を含む mono <T> reactor.core.publisher.Mono<T> bodyToMono(ParameterizedTypeReference<T> typeReference)
Mono
に抽出します。T
- 要素型 typeReference
- 予想されるレスポンス本文の種類を説明する型参照 T
の本体を含む mono <T> reactor.core.publisher.Flux<T> bodyToFlux(ClassSE<? extends T> elementClass)
Flux
に抽出します。T
- 要素型 elementClass
- Flux
の要素のクラス T
の本体を含むフラックス <T> reactor.core.publisher.Flux<T> bodyToFlux(ParameterizedTypeReference<T> typeReference)
Flux
に抽出します。T
- 要素型 typeReference
- 予想されるレスポンス本文の種類を説明する型参照 T
の本体を含むフラックス <T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(ClassSE<T> bodyType)
ResponseEntity
として返します。T
- レスポンス本体型 bodyType
- 予想されるレスポンス本文型 Mono
と ResponseEntity
<T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(ParameterizedTypeReference<T> typeReference)
ResponseEntity
として返します。T
- レスポンス本体型 typeReference
- 予想されるレスポンス本文の種類を説明する型参照 Mono
と ResponseEntity
<T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> toEntityList(ClassSE<T> elementType)
ResponseEntity
の遅延リストとして返します。T
- リスト内の要素の型 elementType
- 予期されるレスポンス本文リストの要素型 ResponseEntity
のリストを持つ Mono
<T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> toEntityList(ParameterizedTypeReference<T> typeReference)
ResponseEntity
の遅延リストとして返します。T
- リスト内の要素の型 typeReference
- 予想されるレスポンス本文の種類を説明する型参照 ResponseEntity
のリストを持つ Mono
static ClientResponse.Builder from(ClientResponse other)
other
- ステータス、ヘッダー、Cookie をコピーするレスポンス static ClientResponse.Builder create(HttpStatus statusCode)
statusCode
- ステータスコード static ClientResponse.Builder create(HttpStatus statusCode, ExchangeStrategies strategies)
statusCode
- ステータスコード strategies
- 戦略 static ClientResponse.Builder create(HttpStatus statusCode, ListSE<HttpMessageReader<?>> messageReaders)
statusCode
- ステータスコード messageReaders
- メッセージリーダー