io.micronaut.session.http

Class HttpSessionConfiguration

java.lang.Object

io.micronaut.session.SessionConfiguration

io.micronaut.session.http.HttpSessionConfiguration

All Implemented Interfaces:

CookieConfiguration

@ConfigurationProperties(value="http")
public class HttpSessionConfiguration
extends SessionConfiguration
implements CookieConfiguration

Allows configuration of the session.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BASE64ENCODE The default base64 encode value.
static java.lang.String	DEFAULT_COOKIENAME Cookie name.
static java.lang.String	DEFAULT_COOKIEPATH Default Cookie Path.
static boolean	DEFAULT_REMEMBERME The default remember me value.

Fields inherited from class io.micronaut.session.SessionConfiguration

DEFAULT_MAXINACTIVEINTERVAL_MINUTES

Constructor Summary

Constructors

Constructor and Description
HttpSessionConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getCookieDomain() Gets the domain name of this Cookie.
java.util.Optional<java.time.temporal.TemporalAmount>	getCookieMaxAge()
java.lang.String	getCookieName()
java.util.Optional<java.lang.String>	getCookiePath() The path of the cookie.
java.util.Optional<SameSite>	getCookieSameSite()
java.util.Optional<java.lang.String>	getDomainName()
java.lang.String[]	getHeaderNames()
java.util.Optional<java.lang.String>	getPrefix()
boolean	isBase64Encode()
java.util.Optional<java.lang.Boolean>	isCookieHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
java.util.Optional<java.lang.Boolean>	isCookieSecure()
boolean	isRememberMe()
void	setBase64Encode(boolean base64Encode) Default value (true).
void	setCookieDomain(java.lang.String cookieDomain)
void	setCookieMaxAge(java.time.temporal.TemporalAmount cookieMaxAge) Sets the maximum age of the cookie.
void	setCookieName(java.lang.String cookieName) Default value ("SESSION").
void	setCookiePath(java.lang.String cookiePath)
void	setCookieSameSite(SameSite sameSite) Determines if this this Cookie can be sent along cross-site requests.
void	setCookieSecure(java.lang.Boolean cookieSecure) Sets the secure status of the cookie.
void	setDomainName(java.lang.String domainName)
void	setHeaderNames(java.lang.String[] headerNames) Default values (["Authorization-Info", "X-Auth-Token"]).
void	setPrefix(java.lang.String prefix)
void	setRememberMe(boolean rememberMe) Default value (false).

Methods inherited from class io.micronaut.session.SessionConfiguration

getExecutorService, getMaxActiveSessions, getMaxInactiveInterval, isPromptExpiration, setExecutorService, setMaxActiveSessions, setMaxInactiveInterval, setPromptExpiration

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COOKIEPATH

public static final java.lang.String DEFAULT_COOKIEPATH

Default Cookie Path.

See Also:

Constant Field Values

DEFAULT_COOKIENAME

public static final java.lang.String DEFAULT_COOKIENAME

Cookie name.

See Also:

Constant Field Values

DEFAULT_REMEMBERME

public static final boolean DEFAULT_REMEMBERME

The default remember me value.

See Also:

Constant Field Values

DEFAULT_BASE64ENCODE

public static final boolean DEFAULT_BASE64ENCODE

The default base64 encode value.

See Also:

Constant Field Values

Constructor Detail

HttpSessionConfiguration

public HttpSessionConfiguration()

Method Detail

isBase64Encode

public boolean isBase64Encode()

Returns:

Whether the Base64 encode sessions IDs sent back to clients

setBase64Encode

public void setBase64Encode(boolean base64Encode)

Default value (true).

Parameters:

base64Encode - Enable the Base64 encode for sessions IDs sent back to clients

getCookieName

public java.lang.String getCookieName()

Specified by:

getCookieName in interface CookieConfiguration

Returns:

The cookie name to use

setCookieName

public void setCookieName(java.lang.String cookieName)

Default value ("SESSION").

Parameters:

cookieName - Set the cookie name to use

getPrefix

public java.util.Optional<java.lang.String> getPrefix()

Returns:

The prefix to use when serializing session ID

setPrefix

public void setPrefix(java.lang.String prefix)

Parameters:

prefix - Set the prefix to use when serializing session ID

getHeaderNames

public java.lang.String[] getHeaderNames()

Returns:

The header names when using a Header strategy

setHeaderNames

public void setHeaderNames(java.lang.String[] headerNames)

Default values (["Authorization-Info", "X-Auth-Token"]).

Parameters:

headerNames - Set the header names when using a Header strategy

getCookiePath

public java.util.Optional<java.lang.String> getCookiePath()

Description copied from interface: CookieConfiguration

The path of the cookie. The cookie is visible to all paths below the request path on the server.

Specified by:

getCookiePath in interface CookieConfiguration

Returns:

The cookie path to use

isCookieHttpOnly

public java.util.Optional<java.lang.Boolean> isCookieHttpOnly()

Description copied from interface: CookieConfiguration

Checks to see if this Cookie can only be accessed via HTTP.

Specified by:

isCookieHttpOnly in interface CookieConfiguration

Returns:

True if the cookie is HTTP only

setCookiePath

public void setCookiePath(java.lang.String cookiePath)

Parameters:

cookiePath - Set the cookie path to use. Default value ("/").

getDomainName

public java.util.Optional<java.lang.String> getDomainName()

Returns:

The domain name to use for the cookie

getCookieDomain

public java.util.Optional<java.lang.String> getCookieDomain()

Description copied from interface: CookieConfiguration

Gets the domain name of this Cookie.

Specified by:

getCookieDomain in interface CookieConfiguration

Returns:

the domain name of this Cookie

setDomainName

public void setDomainName(java.lang.String domainName)

Parameters:

domainName - Set the domain name to use for the cookie

setCookieDomain

public void setCookieDomain(java.lang.String cookieDomain)

Parameters:

cookieDomain - Set the domain name to use for the cookie

getCookieMaxAge

public java.util.Optional<java.time.temporal.TemporalAmount> getCookieMaxAge()

Specified by:

getCookieMaxAge in interface CookieConfiguration

Returns:

The max age to use for the cookie

setCookieMaxAge

public void setCookieMaxAge(java.time.temporal.TemporalAmount cookieMaxAge)

Sets the maximum age of the cookie.

Parameters:

cookieMaxAge - The maximum age of the cookie

isRememberMe

public boolean isRememberMe()

Returns:

Is remember me config

setRememberMe

public void setRememberMe(boolean rememberMe)

Default value (false).

Parameters:

rememberMe - Enable the remember me setting

isCookieSecure

public java.util.Optional<java.lang.Boolean> isCookieSecure()

Specified by:

isCookieSecure in interface CookieConfiguration

Returns:

Is cookie secure

setCookieSecure

public void setCookieSecure(java.lang.Boolean cookieSecure)

Sets the secure status of the cookie. Delegates to HttpRequest.isSecure() if not set.

Parameters:

cookieSecure - Whether or not the cookie is secure.

getCookieSameSite

public java.util.Optional<SameSite> getCookieSameSite()

Specified by:

getCookieSameSite in interface CookieConfiguration

Returns:

return the SameSite to use for the cookie.

setCookieSameSite

public void setCookieSameSite(SameSite sameSite)

Determines if this this Cookie can be sent along cross-site requests. For more information, please look here

Parameters:

sameSite - SameSite value