io.micronaut.security.token.jwt.cookie

Class JwtCookieConfigurationProperties

java.lang.Object

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

All Implemented Interfaces:

Toggleable, JwtCookieConfiguration

@ConfigurationProperties(value="micronaut.security.token.jwt.cookie")
public class JwtCookieConfigurationProperties
extends Object
implements JwtCookieConfiguration

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COOKIENAME The default cookie name.
static boolean	DEFAULT_ENABLED The default enable value.
static String	DEFAULT_LOGINFAILURETARGETURL The default login failure target URL.
static String	DEFAULT_LOGINSUCCESSTARGETURL The default login success target URL.
static String	DEFAULT_LOGOUTTARGETURL The default logout target URL.
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
JwtCookieConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
String	getCookieName() cookieName getter.
String	getLoginFailureTargetUrl()
String	getLoginSuccessTargetUrl()
String	getLogoutTargetUrl()
boolean	isEnabled()
void	setCookieName(String cookieName) Sets the cookie name to use.
void	setEnabled(boolean enabled) Sets whether JWT cookie based security is enabled.
void	setLoginFailureTargetUrl(String loginFailureTargetUrl) Sets the login failure target URL.
void	setLoginSuccessTargetUrl(String loginSuccessTargetUrl) Sets the login success target URL.
void	setLogoutTargetUrl(String logoutTargetUrl) Sets the logout target URL.

Methods inherited from class java.lang.Object

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

Field Detail

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_LOGOUTTARGETURL

public static final String DEFAULT_LOGOUTTARGETURL

The default logout target URL.

See Also:

Constant Field Values

DEFAULT_LOGINSUCCESSTARGETURL

public static final String DEFAULT_LOGINSUCCESSTARGETURL

The default login success target URL.

See Also:

Constant Field Values

DEFAULT_LOGINFAILURETARGETURL

public static final String DEFAULT_LOGINFAILURETARGETURL

The default login failure target URL.

See Also:

Constant Field Values

Constructor Detail

JwtCookieConfigurationProperties

public JwtCookieConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

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

getLogoutTargetUrl

public String getLogoutTargetUrl()

Specified by:

getLogoutTargetUrl in interface JwtCookieConfiguration

Returns:

String to be parsed into a URI which represents where the user is redirected to after logout.

getLoginSuccessTargetUrl

public String getLoginSuccessTargetUrl()

Specified by:

getLoginSuccessTargetUrl in interface JwtCookieConfiguration

Returns:

String to be parsed into a URI which represents where the user is redirected to after a successful login.

getLoginFailureTargetUrl

public String getLoginFailureTargetUrl()

Specified by:

getLoginFailureTargetUrl in interface JwtCookieConfiguration

Returns:

String to be parsed into a URI which represents where the user is redirected to after a failed login.

getCookieName

public String getCookieName()

cookieName getter.

Specified by:

getCookieName in interface JwtCookieConfiguration

Returns:

a String with the Cookie Name

setEnabled

public void setEnabled(boolean enabled)

Sets whether JWT cookie based security is enabled. Default value (false).

Parameters:

enabled - True if it is enabled

setLogoutTargetUrl

public void setLogoutTargetUrl(String logoutTargetUrl)

Sets the logout target URL. Default value ("/").

Parameters:

logoutTargetUrl - The URL

setCookieName

public void setCookieName(String cookieName)

Sets the cookie name to use. Default value ("JWT").

Parameters:

cookieName - The cookie name

setLoginSuccessTargetUrl

public void setLoginSuccessTargetUrl(String loginSuccessTargetUrl)

Sets the login success target URL. Default value ("/").

Parameters:

loginSuccessTargetUrl - The URL

setLoginFailureTargetUrl

public void setLoginFailureTargetUrl(String loginFailureTargetUrl)

Sets the login failure target URL. Default value ("/").

Parameters:

loginFailureTargetUrl - The URL