JwtCookieConfigurationProperties (micronaut 1.1.0 API)

java.lang.Object
- io.micronaut.security.token.jwt.cookie.JwtCookieConfigurationProperties

All Implemented Interfaces:: Toggleable, CookieConfiguration, 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 String`	`DEFAULT_COOKIEPATH` Default Cookie Path.
`static boolean`	`DEFAULT_ENABLED` The default enable value.
`static boolean`	`DEFAULT_HTTPONLY` The default http only 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 boolean`	`DEFAULT_SECURE` The default secure value.
`static String`	`PREFIX`

Constructor Summary

Constructors
Constructor and Description

JwtCookieConfigurationProperties()

Constructors
Constructor and Description
`JwtCookieConfigurationProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`getCookieDomain()` Gets the domain name of this Cookie.
`Optional<TemporalAmount>`	`getCookieMaxAge()`
`String`	`getCookieName()`
`Optional<String>`	`getCookiePath()` The path of the cookie.
`String`	`getLoginFailureTargetUrl()`
`String`	`getLoginSuccessTargetUrl()`
`String`	`getLogoutTargetUrl()`
`Optional<Boolean>`	`isCookieHttpOnly()` Checks to see if this `Cookie` can only be accessed via HTTP.
`Optional<Boolean>`	`isCookieSecure()`
`boolean`	`isEnabled()`
`void`	`setCookieDomain(String cookieDomain)` Sets the domain name of this Cookie.
`void`	`setCookieHttpOnly(Boolean cookieHttpOnly)` Whether the Cookie can only be accessed via HTTP.
`void`	`setCookieMaxAge(TemporalAmount cookieMaxAge)` Sets the maximum age of the cookie.
`void`	`setCookieName(String cookieName)` Cookie Name.
`void`	`setCookiePath(String cookiePath)` Sets the path of the cookie.
`void`	`setCookieSecure(Boolean cookieSecure)` Sets whether the cookie is secured.
`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_SECURE
```
public static final boolean DEFAULT_SECURE
```
    The default secure value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTPONLY
```
public static final boolean DEFAULT_HTTPONLY
```
    The default http only 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
  - 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.
  - setLogoutTargetUrl
```
public void setLogoutTargetUrl(String logoutTargetUrl)
```
    Sets the logout target URL. Default value ("/").
    
    Parameters:
    
    logoutTargetUrl - The URL
  - 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
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether JWT cookie based security is enabled. Default value (false).
    
    Parameters:
    
    enabled - True if it is enabled
  - setCookieName
```
public void setCookieName(String cookieName)
```
    Cookie Name. Default value ("JWT").
    
    Parameters:
    
    cookieName - Cookie name
  - getCookieName
```
@Nonnull
public String getCookieName()
```
    Specified by:
    
    getCookieName in interface CookieConfiguration
    
    Returns:
    
    a name for the cookie
  - getCookieDomain
```
public Optional<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
  - getCookiePath
```
@Nullable
public Optional<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 path of the cookie.
  - isCookieHttpOnly
```
public Optional<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:
    
    Whether the Cookie can only be accessed via HTTP.
  - isCookieSecure
```
public Optional<Boolean> isCookieSecure()
```
    Specified by:
    
    isCookieSecure in interface CookieConfiguration
    
    Returns:
    
    True if the cookie is secure
  - getCookieMaxAge
```
public Optional<TemporalAmount> getCookieMaxAge()
```
    Specified by:
    
    getCookieMaxAge in interface CookieConfiguration
    
    Returns:
    
    The max age to use for the cookie
  - setCookieDomain
```
public void setCookieDomain(@Nullable
                            String cookieDomain)
```
    Sets the domain name of this Cookie. Default value ("JWT").
    
    Parameters:
    
    cookieDomain - the domain name of this Cookie
  - setCookiePath
```
public void setCookiePath(@Nullable
                          String cookiePath)
```
    Sets the path of the cookie. Default value ("/".
    
    Parameters:
    
    cookiePath - The path of the cookie.
  - setCookieHttpOnly
```
public void setCookieHttpOnly(Boolean cookieHttpOnly)
```
    Whether the Cookie can only be accessed via HTTP. Default value (true.
    
    Parameters:
    
    cookieHttpOnly - Whether the Cookie can only be accessed via HTTP
  - setCookieSecure
```
public void setCookieSecure(Boolean cookieSecure)
```
    Sets whether the cookie is secured. Default value (true.
    
    Parameters:
    
    cookieSecure - True if the cookie is secure
  - setCookieMaxAge
```
public void setCookieMaxAge(TemporalAmount cookieMaxAge)
```
    Sets the maximum age of the cookie.
    
    Parameters:
    
    cookieMaxAge - The maximum age of the cookie

Class JwtCookieConfigurationProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX

DEFAULT_ENABLED

DEFAULT_SECURE

DEFAULT_HTTPONLY

DEFAULT_COOKIENAME

DEFAULT_COOKIEPATH

DEFAULT_LOGOUTTARGETURL

DEFAULT_LOGINSUCCESSTARGETURL

DEFAULT_LOGINFAILURETARGETURL

Constructor Detail

JwtCookieConfigurationProperties

Method Detail

isEnabled

getLogoutTargetUrl

getLoginSuccessTargetUrl

getLoginFailureTargetUrl

setLogoutTargetUrl

setLoginSuccessTargetUrl

setLoginFailureTargetUrl

setEnabled

setCookieName

getCookieName

getCookieDomain

getCookiePath

isCookieHttpOnly

isCookieSecure

getCookieMaxAge

setCookieDomain

setCookiePath

setCookieHttpOnly

setCookieSecure

setCookieMaxAge