io.micronaut.security.oauth2.handlers

Class CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.handlers.CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, io.micronaut.http.cookie.CookieConfiguration, CookieSuccessfulIdTokenAccessTokenResponseHandlerConfiguration

@ConfigurationProperties(value="micronaut.security.oauth2.openid.idtoken.cookie")
public class CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties
extends java.lang.Object
implements CookieSuccessfulIdTokenAccessTokenResponseHandlerConfiguration

ConfigurationProperties implementation of CookieSuccessfulIdTokenAccessTokenResponseHandlerConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COOKIEPATH Default Cookie Path.
static boolean	DEFAULT_ENABLED The default enable value.
static boolean	DEFAULT_HTTPONLY The default http only value.
static boolean	DEFAULT_SECURE The default secure value.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getCookieDomain()
java.util.Optional<java.time.temporal.TemporalAmount>	getCookieMaxAge()
java.lang.String	getCookieName()
java.util.Optional<java.lang.String>	getCookiePath()
java.util.Optional<java.net.URI>	getDefaultRedirectUri()
RedirectionStrategy	getRedirectionStrategy()
java.util.Optional<java.lang.Boolean>	isCookieHttpOnly()
java.util.Optional<java.lang.Boolean>	isCookieSecure()
boolean	isEnabled()
void	setCookieDomain(java.lang.String cookieDomain) Sets the domain name of this Cookie.
void	setCookieHttpOnly(boolean cookieHttpOnly) Whether the Cookie can only be accessed via HTTP.
void	setCookieMaxAge(java.time.temporal.TemporalAmount cookieMaxAge) Sets the maximum age of the cookie.
void	setCookieName(java.lang.String cookieName) Cookie Name.
void	setCookiePath(java.lang.String cookiePath) Sets the path of the cookie.
void	setCookieSecure(boolean cookieSecure) Sets whether the cookie is secured.
void	setDefaultRedirectUri(java.net.URI defaultRedirectUri) Sets the login success target URL.
void	setEnabled(boolean enabled) Enables CookieSuccessfulIdTokenAccessTokenResponseHandler.
void	setRedirectionStrategy(RedirectionStrategy redirectionStrategy) Sets the redirection strategy.

Methods inherited from class java.lang.Object

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

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_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_COOKIEPATH

public static final java.lang.String DEFAULT_COOKIEPATH

Default Cookie Path.

See Also:

Constant Field Values

Constructor Detail

CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties

public CookieSuccessfulIdTokenAccessTokenResponseHandlerConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Enables CookieSuccessfulIdTokenAccessTokenResponseHandler. Default value (true).

Parameters:

enabled - enabled flag

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

getCookieDomain

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

Specified by:

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

Returns:

the domain name of this 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.

isCookieHttpOnly

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

Specified by:

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

Returns:

Whether the Cookie can only be accessed via HTTP.

isCookieSecure

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

Specified by:

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

Returns:

True if the cookie is secure

getCookieMaxAge

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

Specified by:

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

Returns:

The max age to use for the cookie

setCookieDomain

public void setCookieDomain(@Nullable
                            java.lang.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
                          java.lang.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(java.time.temporal.TemporalAmount cookieMaxAge)

Sets the maximum age of the cookie.

Parameters:

cookieMaxAge - The maximum age of the cookie

getDefaultRedirectUri

public java.util.Optional<java.net.URI> getDefaultRedirectUri()

Specified by:

getDefaultRedirectUri in interface CookieSuccessfulIdTokenAccessTokenResponseHandlerConfiguration

Returns:

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

setDefaultRedirectUri

public void setDefaultRedirectUri(java.net.URI defaultRedirectUri)

Sets the login success target URL. Default behavior is to redirect back to the original URI.

Parameters:

defaultRedirectUri - The URI

getRedirectionStrategy

public RedirectionStrategy getRedirectionStrategy()

Specified by:

getRedirectionStrategy in interface CookieSuccessfulIdTokenAccessTokenResponseHandlerConfiguration

Returns:

The redirection strategy.

setRedirectionStrategy

public void setRedirectionStrategy(RedirectionStrategy redirectionStrategy)

Sets the redirection strategy. Default value (original).

Parameters:

redirectionStrategy - The redirection strategy