io.micronaut.session.http

Class HttpSessionFilter

java.lang.Object

io.micronaut.session.http.HttpSessionFilter

All Implemented Interfaces:

Ordered, HttpFilter, HttpServerFilter

@Filter(value="/**")
public class HttpSessionFilter
extends java.lang.Object
implements HttpServerFilter

A HttpServerFilter that resolves the current user Session if present and encodes the Session ID in the response.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	ORDER The order of the filter.
static java.lang.CharSequence	SESSION_ATTRIBUTE Constant for Micronaut SESSION attribute.

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
HttpSessionFilter(SessionStore<Session> sessionStore, HttpSessionIdResolver[] resolvers, HttpSessionIdEncoder[] encoders) Constructor.

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.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.
int	getOrder()

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

Field Detail

ORDER

public static final java.lang.Integer ORDER

The order of the filter.

SESSION_ATTRIBUTE

public static final java.lang.CharSequence SESSION_ATTRIBUTE

Constant for Micronaut SESSION attribute.

Constructor Detail

HttpSessionFilter

public HttpSessionFilter(SessionStore<Session> sessionStore,
                         HttpSessionIdResolver[] resolvers,
                         HttpSessionIdEncoder[] encoders)

Constructor.

Parameters:

sessionStore - The session store

resolvers - The HTTP session id resolvers

encoders - The HTTP session id encoders

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

doFilter

public org.reactivestreams.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)