Package io.micronaut.http.cookie

Interface Cookie

All Superinterfaces:

Comparable<Cookie>, Serializable

All Known Implementing Classes:

NettyCookie, SimpleCookie

public interface Cookie
extends Comparable<Cookie>, Serializable

An interface representing a Cookie. See .

Since:

1.0

Author:

Graeme Rocher

See Also:

• RFC6265

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_DOMAIN
static final String	ATTRIBUTE_EXPIRES
static final String	ATTRIBUTE_HTTP_ONLY
static final String	ATTRIBUTE_MAX_AGE
static final String	ATTRIBUTE_PATH
static final String	ATTRIBUTE_SAME_SITE	Controls whether a cookie is sent with cross-site requests.
static final String	ATTRIBUTE_SECURE
static final long	UNDEFINED_MAX_AGE	Constant for undefined MaxAge attribute value.

Method Summary

Modifier and Type	Method	Description
default @NonNull Cookie	configure(@NonNull CookieConfiguration configuration)	Configure the Cookie with the given configuration.
default @NonNull Cookie	configure(@NonNull CookieConfiguration configuration, boolean isSecure)	Configure the Cookie with the given configuration.
@NonNull Cookie	domain(@Nullable String domain)	Sets the domain of the cookie.
@Nullable String	getDomain()	Gets the domain name of this Cookie.
long	getMaxAge()	Gets the maximum age of the cookie in seconds.
@NonNull String	getName()
@Nullable String	getPath()	The path of the cookie.
default Optional<SameSite>	getSameSite()	Checks to see if this Cookie can be sent along cross-site requests.
@NonNull String	getValue()
default @NonNull Cookie	httpOnly()	Sets this cookie as HTTP-Only.
@NonNull Cookie	httpOnly(boolean httpOnly)	Sets whether the cookie is HTTP-Only.
boolean	isHttpOnly()	Checks to see if this Cookie can only be accessed via HTTP.
boolean	isSecure()
@NonNull Cookie	maxAge(long maxAge)	Sets the max age of the cookie in seconds.
default @NonNull Cookie	maxAge(@NonNull TemporalAmount maxAge)	Sets the max age of the cookie.
static @NonNull Cookie	of(@NonNull String name, @NonNull String value)	Construct a new Cookie for the given name and value.
@NonNull Cookie	path(@Nullable String path)	Sets the path of the cookie.
default @NonNull Cookie	sameSite(@Nullable SameSite sameSite)	Determines if this Cookie can be sent along cross-site requests.
default @NonNull Cookie	secure()	Sets this cookie as secure.
@NonNull Cookie	secure(boolean secure)	Sets whether the cookie is secure.
@NonNull Cookie	value(@NonNull String value)	Sets the value.

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

UNDEFINED_MAX_AGE

static final long UNDEFINED_MAX_AGE

Constant for undefined MaxAge attribute value.

See Also:

• Constant Field Values

ATTRIBUTE_SECURE

static final String ATTRIBUTE_SECURE

See Also:

• The Secure Attribute.
• Constant Field Values

ATTRIBUTE_HTTP_ONLY

static final String ATTRIBUTE_HTTP_ONLY

See Also:

• The HttpOnly Attribute.
• Constant Field Values

ATTRIBUTE_SAME_SITE

static final String ATTRIBUTE_SAME_SITE

Controls whether a cookie is sent with cross-site requests.

See Also:

• Constant Field Values

ATTRIBUTE_DOMAIN

static final String ATTRIBUTE_DOMAIN

See Also:

• The Domain Attribute
• Constant Field Values

ATTRIBUTE_PATH

static final String ATTRIBUTE_PATH

See Also:

• The Path Attribute.
• Constant Field Values

ATTRIBUTE_EXPIRES

static final String ATTRIBUTE_EXPIRES

See Also:

• The Expires Attribute.
• Constant Field Values

ATTRIBUTE_MAX_AGE

static final String ATTRIBUTE_MAX_AGE

See Also:

• The Max-Age Attribute
• Constant Field Values

Method Details

getName

@NonNull
@NonNull String getName()

Returns:

The name of the cookie

getValue

@NonNull
@NonNull String getValue()

Returns:

The value of the cookie

getDomain

@Nullable
@Nullable String getDomain()

Gets the domain name of this Cookie.

Domain names are formatted according to RFC 2109.

Returns:

the domain name of this Cookie

getPath

@Nullable
@Nullable String getPath()

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

Returns:

The cookie path

isHttpOnly

boolean isHttpOnly()

Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it.

See here for reference

Returns:

True if this Cookie is HTTP-only or false if it isn't

isSecure

boolean isSecure()

Returns:

True if the cookie is secure

getMaxAge

long getMaxAge()

Gets the maximum age of the cookie in seconds. If the max age has not been explicitly set, then the value returned will be UNDEFINED_MAX_AGE, indicating that the Max-Age Attribute should not be written.

Returns:

The maximum age of the cookie in seconds

getSameSite

default Optional<SameSite> getSameSite()

Checks to see if this Cookie can be sent along cross-site requests. For more information, please look here

Returns:

The SameSite attribute of the cookie

sameSite

@NonNull
default @NonNull Cookie sameSite(@Nullable
 @Nullable SameSite sameSite)

Determines if this Cookie can be sent along cross-site requests. For more information, please look here

Parameters:

sameSite - SameSite value

Returns:

This cookie

maxAge

@NonNull
@NonNull Cookie maxAge(long maxAge)

Sets the max age of the cookie in seconds. When not explicitly set, the max age will default to UNDEFINED_MAX_AGE and cause the Max-Age Attribute not to be encoded.

Parameters:

maxAge - The max age

Returns:

This cookie

value

@NonNull
@NonNull Cookie value(@NonNull
 @NonNull String value)

Sets the value.

Parameters:

value - The value of the cookie

Returns:

This cookie

domain

@NonNull
@NonNull Cookie domain(@Nullable
 @Nullable String domain)

Sets the domain of the cookie.

Parameters:

domain - The domain of the cookie

Returns:

This cookie

path

@NonNull
@NonNull Cookie path(@Nullable
 @Nullable String path)

Sets the path of the cookie.

Parameters:

path - The path of the cookie

Returns:

This cookie

secure

@NonNull
@NonNull Cookie secure(boolean secure)

Sets whether the cookie is secure.

Parameters:

secure - Is the cookie secure

Returns:

This cookie

secure

@NonNull
default @NonNull Cookie secure()

Sets this cookie as secure.

Returns:

This Cookie

Since:

4.3.0

httpOnly

@NonNull
@NonNull Cookie httpOnly(boolean httpOnly)

Sets whether the cookie is HTTP-Only.

Parameters:

httpOnly - Is the cookie HTTP-Only

Returns:

This cookie

httpOnly

@NonNull
default @NonNull Cookie httpOnly()

Sets this cookie as HTTP-Only.

Returns:

This cookie

Since:

4.3.0

configure

@NonNull
default @NonNull Cookie configure(@NonNull
 @NonNull CookieConfiguration configuration)

Configure the Cookie with the given configuration.

Parameters:

configuration - The configuration

Returns:

The cookie

configure

@NonNull
default @NonNull Cookie configure(@NonNull
 @NonNull CookieConfiguration configuration,
 boolean isSecure)

Configure the Cookie with the given configuration.

Parameters:

configuration - The configuration

isSecure - Is the request secure

Returns:

The cookie

maxAge

@NonNull
default @NonNull Cookie maxAge(@NonNull
 @NonNull TemporalAmount maxAge)

Sets the max age of the cookie.

Parameters:

maxAge - The max age

Returns:

This cookie

of

@NonNull
static @NonNull Cookie of(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull String value)

Construct a new Cookie for the given name and value.

Parameters:

name - The name

value - The value

Returns:

The Cookie