org.springframework.web.client.reactive

Interface ClientHttpRequestInterceptor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ClientHttpRequestInterceptor

Contract for chain-based, interception processing of client http requests that may be used to implement cross-cutting requirements such as security, timeouts, caching, and others.

Implementations of this interface can be registered with the WebClient.

Since:

5.0

Author:

Brian Clozel

See Also:

WebClient

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<ClientHttpResponse>	intercept(HttpMethod method, URI uri, ClientHttpRequestInterceptionChain chain) Intercept the client HTTP request

Method Detail

intercept

reactor.core.publisher.Mono<ClientHttpResponse> intercept(HttpMethod method,
                                                          URI uri,
                                                          ClientHttpRequestInterceptionChain chain)

Intercept the client HTTP request

The provided ClientHttpRequestInterceptionChain instance allows the interceptor to delegate the request to the next interceptor in the chain.

An implementation might follow this pattern:

1. Examine the method and uri
2. Optionally change those when delegating to the next interceptor with the ClientHttpRequestInterceptionChain.
3. Optionally transform the HTTP message given as an argument of the request callback in chain.intercept(method, uri, requestCallback).
4. Optionally transform the response before returning it.

Parameters:

method - the HTTP request method

uri - the HTTP request URI

chain - the request interception chain

Returns:

a publisher of the ClientHttpResponse