Enum Class Cookie.SameSite

java.lang.Object

java.lang.Enum<Cookie.SameSite>

org.springframework.boot.web.server.Cookie.SameSite

All Implemented Interfaces:

Serializable, Comparable<Cookie.SameSite>, Constable

Enclosing class:

Cookie

public static enum Cookie.SameSite
extends Enum<Cookie.SameSite>

SameSite values.

Since:

2.6.0

Author:

Phillip Webb, Andy Wilkinson, Brian Clozel, Weix Sun

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LAX	SameSite attribute will be set to Lax.
NONE	SameSite attribute will be set to None.
OMITTED	SameSite attribute will be omitted when creating the cookie.
STRICT	SameSite attribute will be set to Strict.

Method Summary

Modifier and Type	Method	Description
String	attributeValue()
static Cookie.SameSite	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Cookie.SameSite[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OMITTED

public static final Cookie.SameSite OMITTED

SameSite attribute will be omitted when creating the cookie.

NONE

public static final Cookie.SameSite NONE

SameSite attribute will be set to None. Cookies are sent in both first-party and cross-origin requests.

LAX

public static final Cookie.SameSite LAX

SameSite attribute will be set to Lax. Cookies are sent in a first-party context, also when following a link to the origin site.

STRICT

public static final Cookie.SameSite STRICT

SameSite attribute will be set to Strict. Cookies are only sent in a first-party context (i.e. not when following a link to the origin site).

Method Details

values

public static Cookie.SameSite[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Cookie.SameSite valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

attributeValue

public String attributeValue()