Spring Framework 6.1.4 · org.springframework.web.reactive.function.client.ExchangeFunction

Represents a function that exchanges a request for a (delayed) ClientResponse. Can be used as an alternative to WebClient.

For example:

ExchangeFunction exchangeFunction =
        ExchangeFunctions.create(new ReactorClientHttpConnector());

URI url = URI.create("https://example.com/resource");
ClientRequest request = ClientRequest.create(HttpMethod.GET, url).build();

Mono<String> bodyMono = exchangeFunction
    .exchange(request)
    .flatMap(response -> response.bodyToMono(String.class));

Method Summary

Modifier and Type	Method and Description
public Mono<ClientResponse>	Returns: the delayed response exchange(ClientRequest the request to exchange request) Exchange the given request for a `ClientResponse` promise.
public default ExchangeFunction	Returns: the filtered exchange filter(ExchangeFilterFunction the filter to apply to this exchange filter) Filter the exchange function with the given `ExchangeFilterFunction`, resulting in a filtered `ExchangeFunction`.

Method Detail

exchange back to summary

exchange	back to summary
public Mono<ClientResponse> exchange(ClientRequest request) Exchange the given request for a `ClientResponse` promise. Note When calling this method from an `ExchangeFilterFunction` that handles the response in some way, extra care must be taken to always consume its content or otherwise propagate it downstream for further handling, for example by the `WebClient`. Please see the reference documentation for more details on this. Parameters request:ClientRequest the request to exchange Returns:Mono<ClientResponse> the delayed response

public Mono<ClientResponse> exchange(ClientRequest request)

Exchange the given request for a ClientResponse promise.

Note

When calling this method from an ExchangeFilterFunction that handles the response in some way, extra care must be taken to always consume its content or otherwise propagate it downstream for further handling, for example by the WebClient. Please see the reference documentation for more details on this.

Parameters

request:ClientRequest: the request to exchange

Returns:Mono<ClientResponse>

the delayed response

filter back to summary

filter	back to summary
public default ExchangeFunction filter(ExchangeFilterFunction filter) Filter the exchange function with the given `ExchangeFilterFunction`, resulting in a filtered `ExchangeFunction`. Parameters filter:ExchangeFilterFunction the filter to apply to this exchange Returns:ExchangeFunction the filtered exchange See Also `ExchangeFilterFunction#apply(ExchangeFunction)`

public default ExchangeFunction filter(ExchangeFilterFunction filter)

Filter the exchange function with the given ExchangeFilterFunction, resulting in a filtered ExchangeFunction.

Parameters

filter:ExchangeFilterFunction: the filter to apply to this exchange

Returns:ExchangeFunction

the filtered exchange

public Interface ExchangeFunction

Method Summary

Method Detail