io.micronaut.http.filter

Interface HttpClientFilter

All Superinterfaces:

HttpFilter, Ordered

All Known Implementing Classes:

BraveTracingClientFilter, ClientServerContextFilter, ConsulAslTokenFilter, OpenTracingClientFilter, TenantPropagationHttpClientFilter

public interface HttpClientFilter
extends HttpFilter

An HttpClientFilter extends HttpFilter and allows the passed request to be mutated. HttpClientFilter are specific to HTTP client requests and are not processed by the server.

Since:

1.0

Author:

Graeme Rocher

See Also:

HttpFilter

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default Publisher<? extends HttpResponse<?>>	doFilter(HttpRequest<?> request, FilterChain chain) Intercepts a HttpRequest.
Publisher<? extends HttpResponse<?>>	doFilter(MutableHttpRequest<?> request, ClientFilterChain chain) A variation of HttpFilter.doFilter(HttpRequest, FilterChain) that receives a MutableHttpRequest allowing the request to be modified.

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Method Detail

doFilter

Publisher<? extends HttpResponse<?>> doFilter(MutableHttpRequest<?> request,
                                              ClientFilterChain chain)

A variation of HttpFilter.doFilter(HttpRequest, FilterChain) that receives a MutableHttpRequest allowing the request to be modified.

Parameters:

request - The request

chain - The filter chain

Returns:

The publisher of the response

See Also:

HttpFilter

doFilter

default Publisher<? extends HttpResponse<?>> doFilter(HttpRequest<?> request,
                                                      FilterChain chain)

Description copied from interface: HttpFilter

Intercepts a HttpRequest.

Specified by:

doFilter in interface HttpFilter

Parameters:

request - The HttpRequest instance

chain - The FilterChain instance

Returns:

A Publisher for the Http response