io.micronaut.session.http

Class CookieHttpSessionStrategy

java.lang.Object

io.micronaut.session.http.CookieHttpSessionStrategy

All Implemented Interfaces:

HttpSessionIdEncoder, HttpSessionIdResolver, HttpSessionIdStrategy

@Singleton
 @Requires(property="micronaut.session.http.cookie",
          notEquals="false")
public class CookieHttpSessionStrategy
extends java.lang.Object
implements HttpSessionIdStrategy

Resolves Session identifiers from cookies.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
CookieHttpSessionStrategy(HttpSessionConfiguration configuration) Constructor.
CookieHttpSessionStrategy(HttpSessionConfiguration configuration, CookieHttpSessionIdGenerator cookieHttpSessionIdGenerator) Constructor.

Method Summary

Modifier and Type	Method and Description
void	encodeId(io.micronaut.http.HttpRequest<?> request, io.micronaut.http.MutableHttpResponse<?> response, Session session) Encode the given Session into the response.
HttpSessionConfiguration	getConfiguration()
java.util.List<java.lang.String>	resolveIds(io.micronaut.http.HttpRequest<?> message) Resolve the Session ID from the given HTTP message.

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieHttpSessionStrategy

public CookieHttpSessionStrategy(HttpSessionConfiguration configuration)

Constructor.

Parameters:

configuration - The HTTP session configuration

CookieHttpSessionStrategy

public CookieHttpSessionStrategy(HttpSessionConfiguration configuration,
                                 CookieHttpSessionIdGenerator cookieHttpSessionIdGenerator)

Constructor.

Parameters:

configuration - The HTTP session configuration

cookieHttpSessionIdGenerator - Cookie HTTP Session Id generator

Method Detail

resolveIds

public java.util.List<java.lang.String> resolveIds(io.micronaut.http.HttpRequest<?> message)

Description copied from interface: HttpSessionIdResolver

Resolve the Session ID from the given HTTP message.

Specified by:

resolveIds in interface HttpSessionIdResolver

Parameters:

message - The session ID

Returns:

An Optional

encodeId

public void encodeId(io.micronaut.http.HttpRequest<?> request,
                     io.micronaut.http.MutableHttpResponse<?> response,
                     Session session)

Description copied from interface: HttpSessionIdEncoder

Encode the given Session into the response. The strategy can choose to use headers, cookies or whatever strategy suites the use case.

Specified by:

encodeId in interface HttpSessionIdEncoder

Parameters:

request - The request

response - The response

session - The session

getConfiguration

public HttpSessionConfiguration getConfiguration()

Returns:

The HTTP session configuration