io.micronaut.security.token.jwt.cookie

Class JwtCookieConfigurationProperties

java.lang.Object

io.micronaut.security.token.jwt.cookie.AbstractAccessTokenCookieConfigurationProperties

io.micronaut.security.token.jwt.cookie.JwtCookieConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, io.micronaut.http.cookie.CookieConfiguration, TokenCookieConfiguration, AccessTokenCookieConfiguration

@Requires(condition=CookieBasedAuthenticationModeCondition.class) @Requires(property="micronaut.security.token.jwt.cookie.enabled",notEquals="false",defaultValue="true")
 @ConfigurationProperties(value="micronaut.security.token.jwt.cookie")
public class JwtCookieConfigurationProperties
extends AbstractAccessTokenCookieConfigurationProperties
implements AccessTokenCookieConfiguration

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COOKIENAME The default cookie name.
static java.lang.String	DEFAULT_COOKIEPATH Default Cookie Path.
static io.micronaut.http.cookie.SameSite	DEFAULT_COOKIESAMESITE Deprecated. use AbstractAccessTokenCookieConfigurationProperties.DEFAULT_COOKIESAMESITE
static boolean	DEFAULT_ENABLED The default enable value.
static boolean	DEFAULT_HTTPONLY Deprecated. use AbstractAccessTokenCookieConfigurationProperties.DEFAULT_HTTPONLY
static java.lang.String	PREFIX

Fields inherited from class io.micronaut.security.token.jwt.cookie.AbstractAccessTokenCookieConfigurationProperties

cookieDomain, cookieHttpOnly, cookieMaxAge, cookieSameSite, cookieSecure

Constructor Summary

Constructors

Constructor and Description
JwtCookieConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookieName()
java.util.Optional<java.lang.String>	getCookiePath()
boolean	isEnabled()
void	setCookieName(java.lang.String cookieName) Cookie Name.
void	setCookiePath(java.lang.String cookiePath) Sets the path of the cookie.
void	setEnabled(boolean enabled) Sets whether JWT cookie configuration is enabled.

Methods inherited from class io.micronaut.security.token.jwt.cookie.AbstractAccessTokenCookieConfigurationProperties

getCookieDomain, getCookieMaxAge, getCookieSameSite, isCookieHttpOnly, isCookieSecure, setCookieDomain, setCookieHttpOnly, setCookieMaxAge, setCookieSameSite, setCookieSecure

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.cookie.CookieConfiguration

getCookieDomain, getCookieMaxAge, getCookieSameSite, isCookieHttpOnly, isCookieSecure

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_HTTPONLY

@Deprecated
public static final boolean DEFAULT_HTTPONLY

Deprecated. use AbstractAccessTokenCookieConfigurationProperties.DEFAULT_HTTPONLY

The default http only value.

See Also:

Constant Field Values

DEFAULT_COOKIENAME

public static final java.lang.String DEFAULT_COOKIENAME

The default cookie name.

See Also:

Constant Field Values

DEFAULT_COOKIEPATH

public static final java.lang.String DEFAULT_COOKIEPATH

Default Cookie Path.

See Also:

Constant Field Values

DEFAULT_COOKIESAMESITE

@Deprecated
public static final io.micronaut.http.cookie.SameSite DEFAULT_COOKIESAMESITE

Deprecated. use AbstractAccessTokenCookieConfigurationProperties.DEFAULT_COOKIESAMESITE

The default same-site setting for the JWT cookie.

Constructor Detail

JwtCookieConfigurationProperties

public JwtCookieConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

Returns:

a boolean flag indicating whether the JwtCookieTokenReader should be enabled or not

setEnabled

public void setEnabled(boolean enabled)

Sets whether JWT cookie configuration is enabled. Default value (true).

Parameters:

enabled - True if it is enabled

setCookieName

public void setCookieName(java.lang.String cookieName)

Cookie Name. Default value ("JWT").

Parameters:

cookieName - Cookie name

getCookieName

@NonNull
public java.lang.String getCookieName()

Specified by:

getCookieName in interface io.micronaut.http.cookie.CookieConfiguration

Returns:

a name for the cookie

getCookiePath

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

Specified by:

getCookiePath in interface io.micronaut.http.cookie.CookieConfiguration

Returns:

The path of the cookie.

setCookiePath

public void setCookiePath(@Nullable
                          java.lang.String cookiePath)

Sets the path of the cookie. Default value ("/").

Parameters:

cookiePath - The path of the cookie.