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 Object
implements io.micronaut.http.cookie.CookieConfiguration
Base configuration for
CookieConfiguration
implementations.- Author:
- Álvaro Sánchez-Mariscal
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract String
@NonNull String
void
setCookieDomain
(@Nullable String cookieDomain) Sets the domain name of this Cookie.void
setCookieHttpOnly
(Boolean cookieHttpOnly) Whether the Cookie can only be accessed via HTTP.void
setCookieMaxAge
(Duration cookieMaxAge) Sets the maximum age of the cookie.void
setCookieName
(@NonNull String cookieName) Cookie Name.void
setCookiePath
(@Nullable String cookiePath) Sets the path of the cookie.void
setCookieSecure
(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 Details
-
cookieDomain
-
cookieSecure
-
cookiePath
-
cookieHttpOnly
-
cookieMaxAge
-
cookieName
-
-
Constructor Details
-
AbstractCookieConfiguration
public AbstractCookieConfiguration()
-
-
Method Details
-
getCookieDomain
- Specified by:
getCookieDomain
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookieDomain
Sets the domain name of this Cookie. Default value (null).- Parameters:
cookieDomain
- the domain name of this Cookie
-
isCookieSecure
- Specified by:
isCookieSecure
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookieSecure
Sets whether the cookie is secured. Defaults to the secure status of the request.- Parameters:
cookieSecure
- True if the cookie is secure
-
getCookieName
- Specified by:
getCookieName
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookieName
Cookie Name.- Parameters:
cookieName
- Cookie name
-
defaultCookieName
-
getCookiePath
- Specified by:
getCookiePath
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookiePath
Sets the path of the cookie. Default value ("/").- Parameters:
cookiePath
- The path of the cookie.
-
isCookieHttpOnly
- Specified by:
isCookieHttpOnly
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookieHttpOnly
Whether the Cookie can only be accessed via HTTP. Default value (true).- Parameters:
cookieHttpOnly
- Whether the Cookie can only be accessed via HTTP
-
getCookieMaxAge
- Specified by:
getCookieMaxAge
in interfaceio.micronaut.http.cookie.CookieConfiguration
-
setCookieMaxAge
Sets the maximum age of the cookie. Default value (5 minutes).- Parameters:
cookieMaxAge
- The maximum age of the cookie
-