io.micronaut.http.cookie

Interface CookieConfiguration

All Known Implementing Classes:

HttpSessionConfiguration

public interface CookieConfiguration

An interface representing the configuration of a Cookie.

Since:

1.1.0

Author:

Sergio del Amo

Method Summary

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.
default Optional<SameSite>	getCookieSameSite()
Optional<Boolean>	isCookieHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
Optional<Boolean>	isCookieSecure()

Method Detail

getCookieName

@NonNull
String getCookieName()

Returns:

The name of the cookie

getCookieDomain

Optional<String> getCookieDomain()

Gets the domain name of this Cookie.

Returns:

the domain name of this Cookie

getCookiePath

Optional<String> getCookiePath()

The path of the cookie. The cookie is visible to all paths below the request path on the server.

Returns:

The cookie path

isCookieHttpOnly

Optional<Boolean> isCookieHttpOnly()

Checks to see if this Cookie can only be accessed via HTTP.

Returns:

True if the cookie is HTTP only

isCookieSecure

Optional<Boolean> isCookieSecure()

Returns:

True if the cookie is secure

getCookieMaxAge

Optional<TemporalAmount> getCookieMaxAge()

Returns:

The max age to use for the cookie

getCookieSameSite

default Optional<SameSite> getCookieSameSite()

Returns:

return the SameSite to use for the cookie.