org.springframework.web.reactive.function.client

Interface ClientResponse

All Known Implementing Classes:

DefaultClientResponse

public interface ClientResponse

Represents an HTTP response, as returned by the WebClient. Access to headers and body is offered by ClientResponse.Headers and body(BodyExtractor), bodyToMono(Class), bodyToFlux(Class) respectively.

Since:

5.0

Author:

Brian Clozel, Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientResponse.Headers Represents the headers of the HTTP response.

Method Summary

Modifier and Type	Method and Description
<T> T	body(BodyExtractor<T,? super ClientHttpResponse> extractor) Extract the body with the given BodyExtractor.
<T> <any>	bodyToFlux(java.lang.Class<? extends T> elementClass) Extract the body to a Flux.
<T> <any>	bodyToMono(java.lang.Class<? extends T> elementClass) Extract the body to a Mono.
ClientResponse.Headers	headers() Return the headers of this response.
HttpStatus	statusCode() Return the status code of this response.

Method Detail

statusCode

HttpStatus statusCode()

Return the status code of this response.

headers

ClientResponse.Headers headers()

Return the headers of this response.

body

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

Extract the body with the given BodyExtractor. Unlike bodyToMono(Class) and bodyToFlux(Class); this method does not check for a 4xx or 5xx status code before extracting the body.

Type Parameters:

T - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the response

Returns:

the extracted body

bodyToMono

<T> <any> bodyToMono(java.lang.Class<? extends T> elementClass)

Extract the body to a Mono. If the response has status code 4xx or 5xx, the Mono will contain a WebClientException.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Mono

Returns:

a mono containing the body, or a WebClientException if the status code is 4xx or 5xx

bodyToFlux

<T> <any> bodyToFlux(java.lang.Class<? extends T> elementClass)

Extract the body to a Flux. If the response has status code 4xx or 5xx, the Flux will contain a WebClientException.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Flux

Returns:

a flux containing the body, or a WebClientException if the status code is 4xx or 5xx