org.springframework.web.reactive.function.client

Interface WebClient.ResponseSpec

Enclosing interface:

WebClient

public static interface WebClient.ResponseSpec

Contract for specifying response operations following the exchange.

Method Summary

Modifier and Type	Method and Description
<T> reactor.core.publisher.Flux<T>	bodyToFlux(Class<T> elementClass) Extract the body to a Flux.
<T> reactor.core.publisher.Flux<T>	bodyToFlux(ParameterizedTypeReference<T> elementTypeRef) Extract the body to a Flux.
<T> reactor.core.publisher.Mono<T>	bodyToMono(Class<T> elementClass) Extract the body to a Mono.
<T> reactor.core.publisher.Mono<T>	bodyToMono(ParameterizedTypeReference<T> elementTypeRef) Extract the body to a Mono.
WebClient.ResponseSpec	onRawStatus(IntPredicate statusCodePredicate, Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction) Register a custom error function that gets invoked when the given raw status code predicate applies.
WebClient.ResponseSpec	onStatus(Predicate<HttpStatus> statusPredicate, Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction) Register a custom error function that gets invoked when the given HttpStatus predicate applies.
reactor.core.publisher.Mono<ResponseEntity<Void>>	toBodilessEntity() Return the response as a delayed ResponseEntity containing status and headers, but no body.
<T> reactor.core.publisher.Mono<ResponseEntity<T>>	toEntity(Class<T> bodyClass) Return the response as a delayed ResponseEntity.
<T> reactor.core.publisher.Mono<ResponseEntity<T>>	toEntity(ParameterizedTypeReference<T> bodyTypeReference) Return the response as a delayed ResponseEntity.
<T> reactor.core.publisher.Mono<ResponseEntity<List<T>>>	toEntityList(Class<T> elementClass) Return the response as a delayed list of ResponseEntitys.
<T> reactor.core.publisher.Mono<ResponseEntity<List<T>>>	toEntityList(ParameterizedTypeReference<T> elementTypeRef) Return the response as a delayed list of ResponseEntitys.

Method Detail

onStatus

WebClient.ResponseSpec onStatus(Predicate<HttpStatus> statusPredicate,
                                Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction)

Register a custom error function that gets invoked when the given HttpStatus predicate applies. Whatever exception is returned from the function (possibly using ClientResponse.createException()) will also be returned as error signal from bodyToMono(Class) and bodyToFlux(Class).

By default, an error handler is registered that returns a WebClientResponseException when the response status code is 4xx or 5xx. To override this default (and return a non-error response from bodyOn*), register an exception function that returns an empty mono.

NOTE: if the response is expected to have content, the exceptionFunction should consume it. If not, the content will be automatically drained to ensure resources are released.

Parameters:

statusPredicate - a predicate that indicates whether exceptionFunction applies

exceptionFunction - the function that returns the exception

Returns:

this builder

See Also:

ClientResponse.createException()

onRawStatus

WebClient.ResponseSpec onRawStatus(IntPredicate statusCodePredicate,
                                   Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction)

Register a custom error function that gets invoked when the given raw status code predicate applies. The exception returned from the function will be returned from bodyToMono(Class) and bodyToFlux(Class).

By default, an error handler is registered that throws a WebClientResponseException when the response status code is 4xx or 5xx.

Parameters:

statusCodePredicate - a predicate of the raw status code that indicates whether exceptionFunction applies.

NOTE: if the response is expected to have content, the exceptionFunction should consume it. If not, the content will be automatically drained to ensure resources are released.

exceptionFunction - the function that returns the exception

Returns:

this builder

Since:

5.1.9

bodyToMono

<T> reactor.core.publisher.Mono<T> bodyToMono(Class<T> elementClass)

Extract the body to a Mono. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - response body type

Parameters:

elementClass - the expected response body element class

Returns:

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

bodyToMono

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

Extract the body to a Mono. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - response body type

Parameters:

elementTypeRef - a type reference describing the expected response body element type

Returns:

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

bodyToFlux

<T> reactor.core.publisher.Flux<T> bodyToFlux(Class<T> elementClass)

Extract the body to a Flux. By default, if the response has status code 4xx or 5xx, the Flux will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - the type of elements in the response

Parameters:

elementClass - the class of elements in the response

Returns:

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

bodyToFlux

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

Extract the body to a Flux. By default, if the response has status code 4xx or 5xx, the Flux will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - the type of elements in the response

Parameters:

elementTypeRef - a type reference describing the expected response body element type

Returns:

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

toEntity

<T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(Class<T> bodyClass)

Return the response as a delayed ResponseEntity. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - response body type

Parameters:

bodyClass - the expected response body type

Returns:

Mono with the ResponseEntity

Since:

5.2

toEntity

<T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(ParameterizedTypeReference<T> bodyTypeReference)

Return the response as a delayed ResponseEntity. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - response body type

Parameters:

bodyTypeReference - a type reference describing the expected response body type

Returns:

Mono with the ResponseEntity

Since:

5.2

toEntityList

<T> reactor.core.publisher.Mono<ResponseEntity<List<T>>> toEntityList(Class<T> elementClass)

Return the response as a delayed list of ResponseEntitys. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - the type of elements in the list

Parameters:

elementClass - the expected response body list element class

Returns:

Mono with the list of ResponseEntitys

Since:

5.2

toEntityList

<T> reactor.core.publisher.Mono<ResponseEntity<List<T>>> toEntityList(ParameterizedTypeReference<T> elementTypeRef)

Return the response as a delayed list of ResponseEntitys. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function).

Type Parameters:

T - the type of elements in the list

Parameters:

elementTypeRef - the expected response body list element reference type

Returns:

Mono with the list of ResponseEntitys

Since:

5.2

toBodilessEntity

reactor.core.publisher.Mono<ResponseEntity<Void>> toBodilessEntity()

Return the response as a delayed ResponseEntity containing status and headers, but no body. By default, if the response has status code 4xx or 5xx, the Mono will contain a WebClientException. This can be overridden with onStatus(Predicate, Function). Calling this method will release the body of the response.

Returns:

Mono with the bodiless ResponseEntity

Since:

5.2