io.micronaut.session.http

Class CookieHttpSessionIdGenerator

java.lang.Object

io.micronaut.session.http.CookieHttpSessionIdGenerator

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

Utility to generate a session id from a cookie value or builds a cookie value from session.

Since:

1.0.1

Constructor Summary

Constructors

Constructor and Description
CookieHttpSessionIdGenerator(HttpSessionConfiguration configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	cookieValueFromSession(@NotNull Session session)
java.lang.String	getPrefix()
boolean	isBase64Decode()
@NotNull java.lang.String	sessionIdFromCookie(@NotNull io.micronaut.http.cookie.Cookie cookie)

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieHttpSessionIdGenerator

public CookieHttpSessionIdGenerator(HttpSessionConfiguration configuration)

Constructor.

Parameters:

configuration - The HTTP session configuration

Method Detail

isBase64Decode

public boolean isBase64Decode()

Returns:

Whether the Base64 encode sessions IDs sent back to clients

getPrefix

public java.lang.String getPrefix()

Returns:

The prefix to use when serializing session ID

sessionIdFromCookie

@NotNull
public @NotNull java.lang.String sessionIdFromCookie(@NotNull
                                                              @NotNull io.micronaut.http.cookie.Cookie cookie)

Parameters:

cookie - A Cookie

Returns:

A session id from a cookie value

cookieValueFromSession

@NotNull
public @NotNull java.lang.String cookieValueFromSession(@NotNull
                                                                 @NotNull Session session)

Parameters:

session - The session

Returns:

Cookie value from session.