Package io.micronaut.security.oauth2.endpoint

Class AbstractCookieConfiguration

java.lang.Object

io.micronaut.security.oauth2.endpoint.AbstractCookieConfiguration

All Implemented Interfaces:

io.micronaut.http.cookie.CookieConfiguration

Direct Known Subclasses:

CookieNoncePersistenceConfiguration, CookiePkcePersistenceConfiguration, CookieStatePersistenceConfiguration

public abstract class AbstractCookieConfiguration
extends java.lang.Object
implements io.micronaut.http.cookie.CookieConfiguration

Base configuration for CookieConfiguration implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	cookieDomain
protected java.lang.Boolean	cookieHttpOnly
protected java.time.Duration	cookieMaxAge
protected java.lang.String	cookieName
protected java.lang.String	cookiePath
protected java.lang.Boolean	cookieSecure

Constructor Summary

Constructors

Constructor	Description
AbstractCookieConfiguration()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	defaultCookieName()
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.lang.Boolean>	isCookieHttpOnly()
java.util.Optional<java.lang.Boolean>	isCookieSecure()
void	setCookieDomain(java.lang.String cookieDomain)	Sets the domain name of this Cookie.
void	setCookieHttpOnly(java.lang.Boolean cookieHttpOnly)	Whether the Cookie can only be accessed via HTTP.
void	setCookieMaxAge(java.time.Duration 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(java.lang.Boolean cookieSecure)	Sets whether the cookie is secured.

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

getCookieSameSite

Field Detail

cookieDomain

protected java.lang.String cookieDomain

cookieSecure

protected java.lang.Boolean cookieSecure

cookiePath

protected java.lang.String cookiePath

cookieHttpOnly

protected java.lang.Boolean cookieHttpOnly

cookieMaxAge

protected java.time.Duration cookieMaxAge

cookieName

protected java.lang.String cookieName

Constructor Detail

AbstractCookieConfiguration

public AbstractCookieConfiguration()

Method Detail

getCookieDomain

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

Specified by:

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

setCookieDomain

public void setCookieDomain(@Nullable
                            java.lang.String cookieDomain)

Sets the domain name of this Cookie. Default value (null).

Parameters:

cookieDomain - the domain name of this Cookie

isCookieSecure

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

Specified by:

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

setCookieSecure

public void setCookieSecure(java.lang.Boolean cookieSecure)

Sets whether the cookie is secured. Defaults to the secure status of the request.

Parameters:

cookieSecure - True if the cookie is secure

getCookieName

@NonNull
public java.lang.String getCookieName()

Specified by:

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

setCookieName

public void setCookieName(@NonNull
                          java.lang.String cookieName)

Cookie Name.

Parameters:

cookieName - Cookie name

defaultCookieName

public abstract java.lang.String defaultCookieName()

getCookiePath

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

Specified by:

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

setCookiePath

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

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

Parameters:

cookiePath - The path of the cookie.

isCookieHttpOnly

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

Specified by:

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

setCookieHttpOnly

public void setCookieHttpOnly(java.lang.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

getCookieMaxAge

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

Specified by:

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

setCookieMaxAge

public void setCookieMaxAge(java.time.Duration cookieMaxAge)

Sets the maximum age of the cookie. Default value (5 minutes).

Parameters:

cookieMaxAge - The maximum age of the cookie