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 https://tools.ietf.org/html/rfc6265.

Since:

1.0

Author:

Graeme Rocher

Method Summary

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

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

@NonNull
String getName()

Returns:

The name of the cookie

getValue

@NonNull
String getValue()

Returns:

The value of the cookie

getDomain

@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
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()

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 Cookie sameSite(@Nullable
                                 SameSite sameSite)

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

Parameters:

sameSite - SameSite value

Returns:

This cookie

maxAge

@NonNull
Cookie maxAge(long maxAge)

Sets the max age of the cookie in seconds.

Parameters:

maxAge - The max age

Returns:

This cookie

value

@NonNull
Cookie value(@NonNull
                      String value)

Sets the value.

Parameters:

value - The value of the cookie

Returns:

This cookie

domain

@NonNull
Cookie domain(@Nullable
                       String domain)

Sets the domain of the cookie.

Parameters:

domain - The domain of the cookie

Returns:

This cookie

path

@NonNull
Cookie path(@Nullable
                     String path)

Sets the path of the cookie.

Parameters:

path - The path of the cookie

Returns:

This cookie

secure

@NonNull
Cookie secure(boolean secure)

Sets whether the cookie is secure.

Parameters:

secure - Is the cookie secure

Returns:

This cookie

httpOnly

@NonNull
Cookie httpOnly(boolean httpOnly)

Sets whether the cookie is HTTP-Only.

Parameters:

httpOnly - Is the cookie HTTP-Only

Returns:

This cookie

configure

@NonNull
default Cookie configure(@NonNull
                                  CookieConfiguration configuration)

Configure the Cookie with the given configuration.

Parameters:

configuration - The configuration

Returns:

The cookie

configure

@NonNull
default Cookie configure(@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 Cookie maxAge(@NonNull
                               TemporalAmount maxAge)

Sets the max age of the cookie.

Parameters:

maxAge - The max age

Returns:

This cookie

of

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

Construct a new Cookie for the given name and value.

Parameters:

name - The name

value - The value

Returns:

The Cookie