io.micronaut.http.filter

Class OncePerRequestHttpServerFilter

java.lang.Object

io.micronaut.http.filter.OncePerRequestHttpServerFilter

All Implemented Interfaces:

Ordered, HttpFilter, HttpServerFilter

Direct Known Subclasses:

EndpointsFilter, HealthResultFilter, HttpSessionFilter

public abstract class OncePerRequestHttpServerFilter
extends Object
implements HttpServerFilter

A filter that is only executed once per request. A filter may be executed more than once per request if the original route throws an exception.

Since:

1.0

Author:

Graeme Rocher

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
OncePerRequestHttpServerFilter()

Method Summary

Modifier and Type	Method and Description
Publisher<MutableHttpResponse<?>>	doFilter(HttpRequest<?> request, ServerFilterChain chain) Variation of the HttpServerFilter.doFilter(HttpRequest, FilterChain) method that accepts a ServerFilterChain which allows to mutate the outgoing HTTP response.
protected abstract Publisher<MutableHttpResponse<?>>	doFilterOnce(HttpRequest<?> request, ServerFilterChain chain)
static String	getKey(Class<? extends OncePerRequestHttpServerFilter> filterClass) Obtain the key used to store the attribute within a request.

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.HttpServerFilter

doFilter

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

getOrder

Constructor Detail

OncePerRequestHttpServerFilter

public OncePerRequestHttpServerFilter()

Method Detail

doFilter

public final Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request,
                                                        ServerFilterChain chain)

Description copied from interface: HttpServerFilter

Variation of the HttpServerFilter.doFilter(HttpRequest, FilterChain) method that accepts a ServerFilterChain which allows to mutate the outgoing HTTP response.

Specified by:

doFilter in interface HttpServerFilter

Parameters:

request - The request

chain - The chain

Returns:

A Publisher that emits a MutableHttpResponse

See Also:

HttpServerFilter.doFilter(HttpRequest, FilterChain)

getKey

public static String getKey(Class<? extends OncePerRequestHttpServerFilter> filterClass)

Obtain the key used to store the attribute within a request.

Parameters:

filterClass - the filter class

Returns:

The key

doFilterOnce

protected abstract Publisher<MutableHttpResponse<?>> doFilterOnce(HttpRequest<?> request,
                                                                  ServerFilterChain chain)

Parameters:

request - The HttpRequest instance

chain - The ServerFilterChain instance

Returns:

A Publisher for the Http response