Class HttpSessionFilter

java.lang.Object

io.micronaut.session.http.HttpSessionFilter

All Implemented Interfaces:

io.micronaut.core.order.Ordered

@Requires(property="micronaut.session.filter.enabled",
          notEquals="false",
          defaultValue="true")
@ServerFilter(patternStyle=REGEX,
              value="${micronaut.session.filter.regex-pattern:^.*$}")
public class HttpSessionFilter
extends Object
implements io.micronaut.core.order.Ordered

A server filter 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	Description
static final Integer	ORDER	The order of the filter.
static final 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	Description
HttpSessionFilter(SessionStore<Session> sessionStore, HttpSessionIdResolver[] resolvers, HttpSessionIdEncoder[] encoders)	Constructor.

Method Summary

Modifier and Type	Method	Description
CompletionStage<io.micronaut.http.HttpRequest<?>>	filterRequest(io.micronaut.http.HttpRequest<?> request)	Resolve an existing HTTP session before the matched route is invoked.
CompletionStage<io.micronaut.http.MutableHttpResponse<?>>	filterResponse(io.micronaut.http.HttpRequest<?> request, io.micronaut.http.MutableHttpResponse<?> response, @Nullable io.micronaut.web.router.RouteInfo<?> routeInfo)	Persist and encode the HTTP session after the matched route has produced a response.
int	getOrder()

Methods inherited from class Object

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

Field Details

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 Details

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 Details

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

filterRequest

@RequestFilter
public CompletionStage<io.micronaut.http.HttpRequest<?>> filterRequest(io.micronaut.http.HttpRequest<?> request)

Resolve an existing HTTP session before the matched route is invoked.

Parameters:

request - The request

Returns:

The request to continue with

filterResponse

@ResponseFilter
public CompletionStage<io.micronaut.http.MutableHttpResponse<?>> filterResponse(io.micronaut.http.HttpRequest<?> request,
 io.micronaut.http.MutableHttpResponse<?> response,
 @Nullable io.micronaut.web.router.RouteInfo<?> routeInfo)

Persist and encode the HTTP session after the matched route has produced a response.

Parameters:

request - The request

response - The response

routeInfo - The matched route information, if any

Returns:

The response to continue with