Package org.springframework.web.reactive.function.client.support

Class WebClientAdapter

java.lang.Object

org.springframework.web.reactive.function.client.support.WebClientAdapter

All Implemented Interfaces:

HttpClientAdapter

public final class WebClientAdapter
extends Object
implements HttpClientAdapter

HttpClientAdapter that enables an HttpServiceProxyFactory to use WebClient for request execution.

Use static factory methods in this class to create an HttpServiceProxyFactory configured with a given WebClient.

Since:

6.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
static WebClientAdapter	forClient(WebClient webClient)	Create a WebClientAdapter for the given WebClient instance.
reactor.core.publisher.Mono<ResponseEntity<Void>>	requestToBodilessEntity(HttpRequestValues requestValues)	Variant of HttpClientAdapter.requestToVoid(HttpRequestValues) with additional access to the response status and headers.
<T> reactor.core.publisher.Mono<T>	requestToBody(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)	Perform the given request and decode the response content to the given type.
<T> reactor.core.publisher.Flux<T>	requestToBodyFlux(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)	Perform the given request and decode the response content to a stream with elements of the given type.
<T> reactor.core.publisher.Mono<ResponseEntity<T>>	requestToEntity(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)	Variant of HttpClientAdapter.requestToBody(HttpRequestValues, ParameterizedTypeReference) with additional access to the response status and headers.
<T> reactor.core.publisher.Mono<ResponseEntity<reactor.core.publisher.Flux<T>>>	requestToEntityFlux(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType)	Variant of HttpClientAdapter.requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference) with additional access to the response status and headers.
reactor.core.publisher.Mono<HttpHeaders>	requestToHeaders(HttpRequestValues requestValues)	Perform the given request, release the response content, and return the response headers.
reactor.core.publisher.Mono<Void>	requestToVoid(HttpRequestValues requestValues)	Perform the given request, and release the response content, if any.

Methods inherited from class java.lang.Object

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

Method Details

requestToVoid

public reactor.core.publisher.Mono<Void> requestToVoid(HttpRequestValues requestValues)

Description copied from interface: HttpClientAdapter

Perform the given request, and release the response content, if any.

Specified by:

requestToVoid in interface HttpClientAdapter

Parameters:

requestValues - the request to perform

Returns:

Mono that completes when the request is fully executed and the response content is released.

requestToHeaders

public reactor.core.publisher.Mono<HttpHeaders> requestToHeaders(HttpRequestValues requestValues)

Description copied from interface: HttpClientAdapter

Perform the given request, release the response content, and return the response headers.

Specified by:

requestToHeaders in interface HttpClientAdapter

Parameters:

requestValues - the request to perform

Returns:

Mono that returns the response headers the request is fully executed and the response content released.

requestToBody

public <T> reactor.core.publisher.Mono<T> requestToBody(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

Description copied from interface: HttpClientAdapter

Perform the given request and decode the response content to the given type.

Specified by:

requestToBody in interface HttpClientAdapter

Type Parameters:

T - the type the response is decoded to

Parameters:

requestValues - the request to perform

bodyType - the target type to decode to

Returns:

Mono that returns the decoded response.

requestToBodyFlux

public <T> reactor.core.publisher.Flux<T> requestToBodyFlux(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

Description copied from interface: HttpClientAdapter

Perform the given request and decode the response content to a stream with elements of the given type.

Specified by:

requestToBodyFlux in interface HttpClientAdapter

Type Parameters:

T - the type the response is decoded to

Parameters:

requestValues - the request to perform

bodyType - the target stream element type to decode to

Returns:

Flux with decoded stream elements.

requestToBodilessEntity

public reactor.core.publisher.Mono<ResponseEntity<Void>> requestToBodilessEntity(HttpRequestValues requestValues)

Description copied from interface: HttpClientAdapter

Variant of HttpClientAdapter.requestToVoid(HttpRequestValues) with additional access to the response status and headers.

Specified by:

requestToBodilessEntity in interface HttpClientAdapter

requestToEntity

public <T>
reactor.core.publisher.Mono<ResponseEntity<T>> requestToEntity(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

Description copied from interface: HttpClientAdapter

Variant of HttpClientAdapter.requestToBody(HttpRequestValues, ParameterizedTypeReference) with additional access to the response status and headers.

Specified by:

requestToEntity in interface HttpClientAdapter

requestToEntityFlux

public <T>
reactor.core.publisher.Mono<ResponseEntity<reactor.core.publisher.Flux<T>>> requestToEntityFlux(HttpRequestValues requestValues,
 ParameterizedTypeReference<T> bodyType)

Description copied from interface: HttpClientAdapter

Variant of HttpClientAdapter.requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference) with additional access to the response status and headers.

Specified by:

requestToEntityFlux in interface HttpClientAdapter

forClient

public static WebClientAdapter forClient(WebClient webClient)

Create a WebClientAdapter for the given WebClient instance.

Parameters:

webClient - the client to use

Returns:

the created adapter instance