io.micronaut.security.token.propagation

Class TokenPropagationHttpClientFilter

java.lang.Object

io.micronaut.security.token.propagation.TokenPropagationHttpClientFilter

All Implemented Interfaces:

Ordered, HttpClientFilter, HttpFilter

@Filter(value="${micronaut.security.token.propagation.path:/**}")
 @Requires(beans={TokenWriter.class,TokenPropagationConfiguration.class}) @Requires(property="micronaut.security.token.propagation.enabled")
public class TokenPropagationHttpClientFilter
extends Object
implements HttpClientFilter

HttpClientFilter to enable Token propagation.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
protected OutgoingHttpRequestProcessor	outgoingHttpRequestProcessor
protected TokenPropagationConfiguration	tokenPropagationConfiguration
protected TokenWriter	tokenWriter

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
TokenPropagationHttpClientFilter(TokenWriter tokenWriter, TokenPropagationConfiguration tokenPropagationConfiguration, OutgoingHttpRequestProcessor outgoingHttpRequestProcessor)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.filter.HttpClientFilter

doFilter

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

getOrder

Field Detail

tokenPropagationConfiguration

protected final TokenPropagationConfiguration tokenPropagationConfiguration

tokenWriter

protected final TokenWriter tokenWriter

outgoingHttpRequestProcessor

protected final OutgoingHttpRequestProcessor outgoingHttpRequestProcessor

Constructor Detail

TokenPropagationHttpClientFilter

public TokenPropagationHttpClientFilter(TokenWriter tokenWriter,
                                        TokenPropagationConfiguration tokenPropagationConfiguration,
                                        OutgoingHttpRequestProcessor outgoingHttpRequestProcessor)

Parameters:

tokenWriter - bean responsible of writing the token to the target request

tokenPropagationConfiguration - JWT Propagation configuration

outgoingHttpRequestProcessor - Utility to decide whether to process the request

Method Detail

doFilter

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

Description copied from interface: HttpClientFilter

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

Specified by:

doFilter in interface HttpClientFilter

Parameters:

targetRequest - The target request

chain - The filter chain

Returns:

The publisher of the response

See Also:

HttpFilter

doFilter

public Publisher<? extends HttpResponse<?>> doFilter(MutableHttpRequest<?> targetRequest,
                                                     ClientFilterChain chain,
                                                     HttpRequest<Object> currentRequest)

Parameters:

targetRequest - The target request of this HttpClientFilter

chain - The filter chain

currentRequest - The original request which triggered during its execution the invocation of this HttpClientFilter

Returns:

The publisher of the response