Class TokenCookieConfigurationProperties

java.lang.Object

io.micronaut.security.token.cookie.AbstractAccessTokenCookieConfigurationProperties

io.micronaut.security.token.cookie.TokenCookieConfigurationProperties

All Implemented Interfaces:

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

@Requires(classes=io.micronaut.http.cookie.CookieConfiguration.class) @Requires(condition=CookieBasedAuthenticationModeCondition.class) @Requires(property="micronaut.security.token.cookie.enabled",notEquals="false",defaultValue="true")
@ConfigurationProperties("micronaut.security.token.cookie")
public class TokenCookieConfigurationProperties
extends AbstractAccessTokenCookieConfigurationProperties
implements AccessTokenCookieConfiguration

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COOKIENAME	The default cookie name.
static final String	DEFAULT_COOKIEPATH	Default Cookie Path.
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PREFIX

Fields inherited from class AbstractAccessTokenCookieConfigurationProperties

cookieDomain, cookieHttpOnly, cookieMaxAge, cookieSameSite, cookieSecure, DEFAULT_COOKIESAMESITE, DEFAULT_HTTPONLY, sessionCookie

Constructor Summary

Constructors

Constructor	Description
TokenCookieConfigurationProperties()

Method Summary

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

Methods inherited from class AbstractAccessTokenCookieConfigurationProperties

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

Methods inherited from class 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

Methods inherited from interface TokenCookieConfiguration

isSessionCookie

Field Details

PREFIX

public static final 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_COOKIENAME

public static final String DEFAULT_COOKIENAME

The default cookie name.

See Also:

• Constant Field Values

DEFAULT_COOKIEPATH

public static final String DEFAULT_COOKIEPATH

Default Cookie Path.

See Also:

• Constant Field Values

Constructor Details

TokenCookieConfigurationProperties

public TokenCookieConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Whether JWT cookie configuration is enabled. Default value (true).

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(String cookieName)

Cookie Name. Default value ("JWT").

Parameters:

cookieName - Cookie name

getCookieName

public @NonNull String getCookieName()

Cookie Name. Default value ("JWT").

Specified by:

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

Returns:

a name for the cookie

getCookiePath

public @Nullable Optional<String> getCookiePath()

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

Specified by:

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

Returns:

The path of the cookie.

setCookiePath

public void setCookiePath(@Nullable String cookiePath)

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

Parameters:

cookiePath - The path of the cookie.