io.micronaut.session.http

Class HttpSessionFilter

java.lang.Object

io.micronaut.http.filter.OncePerRequestHttpServerFilter

io.micronaut.session.http.HttpSessionFilter

All Implemented Interfaces:

Ordered, HttpFilter, HttpServerFilter

@Filter(value="/**")
public class HttpSessionFilter
extends OncePerRequestHttpServerFilter

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 Integer	ORDER The order of the filter.
static 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
protected Publisher<MutableHttpResponse<?>>	doFilterOnce(HttpRequest<?> request, ServerFilterChain chain)
int	getOrder()

Methods inherited from class io.micronaut.http.filter.OncePerRequestHttpServerFilter

doFilter, getKey

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 Integer ORDER

The order of the filter.

SESSION_ATTRIBUTE

public static final 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()

Returns:

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

doFilterOnce

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

Specified by:

doFilterOnce in class OncePerRequestHttpServerFilter

Parameters:

request - The HttpRequest instance

chain - The ServerFilterChain instance

Returns:

A Publisher for the Http response