org.springframework.web.reactive.function.client

Class DefaultWebClient.DefaultResponseSpec

java.lang.Object

org.springframework.web.reactive.function.client.DefaultWebClient.DefaultResponseSpec

All Implemented Interfaces:

WebClient.ResponseSpec

Enclosing class:

DefaultWebClient

private static class DefaultWebClient.DefaultResponseSpec
extends java.lang.Object
implements WebClient.ResponseSpec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultWebClient.DefaultResponseSpec.StatusHandler

Field Summary

Fields

Modifier and Type	Field and Description
private static DefaultWebClient.DefaultResponseSpec.StatusHandler	DEFAULT_STATUS_HANDLER
private java.util.function.Supplier<HttpRequest>	requestSupplier
private <any>	responseMono
private static java.util.function.IntPredicate	STATUS_CODE_ERROR
private java.util.List<DefaultWebClient.DefaultResponseSpec.StatusHandler>	statusHandlers

Constructor Summary

Constructors

Constructor and Description
DefaultResponseSpec(<any> responseMono, java.util.function.Supplier<HttpRequest> requestSupplier)

Method Summary

Modifier and Type	Method and Description
<T> <any>	bodyToFlux(java.lang.Class<T> elementType) Extract the body to a Flux.
<T> <any>	bodyToFlux(ParameterizedTypeReference<T> elementType) Extract the body to a Flux.
<T> <any>	bodyToMono(java.lang.Class<T> bodyType) Extract the body to a Mono.
<T> <any>	bodyToMono(ParameterizedTypeReference<T> bodyType) Extract the body to a Mono.
private static <any>	createResponseException(ClientResponse response, HttpRequest request)
private <T> <any>	drainBody(ClientResponse response, java.lang.Throwable ex)
private <T extends <any>> T	handleBody(ClientResponse response, T bodyPublisher, java.util.function.Function<<any>,T> errorFunction)
WebClient.ResponseSpec	onRawStatus(java.util.function.IntPredicate statusCodePredicate, java.util.function.Function<ClientResponse,<any>> exceptionFunction) Register a custom error function that gets invoked when the given raw status code predicate applies.
WebClient.ResponseSpec	onStatus(java.util.function.Predicate<HttpStatus> statusPredicate, java.util.function.Function<ClientResponse,<any>> exceptionFunction) Register a custom error function that gets invoked when the given HttpStatus predicate applies.
private static java.util.function.IntPredicate	toIntPredicate(java.util.function.Predicate<HttpStatus> predicate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATUS_CODE_ERROR

private static final java.util.function.IntPredicate STATUS_CODE_ERROR

DEFAULT_STATUS_HANDLER

private static final DefaultWebClient.DefaultResponseSpec.StatusHandler DEFAULT_STATUS_HANDLER

responseMono

private final <any> responseMono

requestSupplier

private final java.util.function.Supplier<HttpRequest> requestSupplier

statusHandlers

private final java.util.List<DefaultWebClient.DefaultResponseSpec.StatusHandler> statusHandlers

Constructor Detail

DefaultResponseSpec

DefaultResponseSpec(<any> responseMono,
                    java.util.function.Supplier<HttpRequest> requestSupplier)

Method Detail

onStatus

public WebClient.ResponseSpec onStatus(java.util.function.Predicate<HttpStatus> statusPredicate,
                                       java.util.function.Function<ClientResponse,<any>> exceptionFunction)

Description copied from interface: WebClient.ResponseSpec

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

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

Specified by:

onStatus in interface WebClient.ResponseSpec

Parameters:

statusPredicate - a predicate 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

toIntPredicate

private static java.util.function.IntPredicate toIntPredicate(java.util.function.Predicate<HttpStatus> predicate)

onRawStatus

public WebClient.ResponseSpec onRawStatus(java.util.function.IntPredicate statusCodePredicate,
                                          java.util.function.Function<ClientResponse,<any>> exceptionFunction)

Description copied from interface: WebClient.ResponseSpec

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 WebClient.ResponseSpec.bodyToMono(Class) and WebClient.ResponseSpec.bodyToFlux(Class).

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

Specified by:

onRawStatus in interface WebClient.ResponseSpec

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

bodyToMono

public <T> <any> bodyToMono(java.lang.Class<T> bodyType)

Description copied from interface: WebClient.ResponseSpec

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 WebClient.ResponseSpec.onStatus(Predicate, Function).

Specified by:

bodyToMono in interface WebClient.ResponseSpec

Type Parameters:

T - response body type

Parameters:

bodyType - the expected response body type

Returns:

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

bodyToMono

public <T> <any> bodyToMono(ParameterizedTypeReference<T> bodyType)

Description copied from interface: WebClient.ResponseSpec

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 WebClient.ResponseSpec.onStatus(Predicate, Function).

Specified by:

bodyToMono in interface WebClient.ResponseSpec

Type Parameters:

T - response body type

Parameters:

bodyType - a type reference describing the expected response body type

Returns:

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

bodyToFlux

public <T> <any> bodyToFlux(java.lang.Class<T> elementType)

Description copied from interface: WebClient.ResponseSpec

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 WebClient.ResponseSpec.onStatus(Predicate, Function).

Specified by:

bodyToFlux in interface WebClient.ResponseSpec

Type Parameters:

T - the type of elements in the response

Parameters:

elementType - the type of element in the response

Returns:

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

bodyToFlux

public <T> <any> bodyToFlux(ParameterizedTypeReference<T> elementType)

Description copied from interface: WebClient.ResponseSpec

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 WebClient.ResponseSpec.onStatus(Predicate, Function).

Specified by:

bodyToFlux in interface WebClient.ResponseSpec

Type Parameters:

T - the type of elements in the response

Parameters:

elementType - a type reference describing the expected response body type

Returns:

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

handleBody

private <T extends <any>> T handleBody(ClientResponse response,
                                       T bodyPublisher,
                                       java.util.function.Function<<any>,T> errorFunction)

drainBody

private <T> <any> drainBody(ClientResponse response,
                            java.lang.Throwable ex)

createResponseException

private static <any> createResponseException(ClientResponse response,
                                             HttpRequest request)