Module net.shibboleth.utilities.java.support

Package net.shibboleth.utilities.java.support.net

Enum SameSiteCookieHeaderFilter.SameSiteValue

java.lang.Object

java.lang.Enum<SameSiteCookieHeaderFilter.SameSiteValue>

net.shibboleth.utilities.java.support.net.SameSiteCookieHeaderFilter.SameSiteValue

All Implemented Interfaces:

Serializable, Comparable<SameSiteCookieHeaderFilter.SameSiteValue>

Enclosing class:

SameSiteCookieHeaderFilter

public static enum SameSiteCookieHeaderFilter.SameSiteValue
extends Enum<SameSiteCookieHeaderFilter.SameSiteValue>

The allowed same-site cookie attribute values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Lax	Send the cookie for 'same-site' requests along with 'cross-site' top level navigations using safe HTTP methods (GET, HEAD, OPTIONS, and TRACE).
None	Send the cookie for 'same-site' and 'cross-site' requests.
Null	Specify nothing.
Strict	Send the cookie for 'same-site' requests only.

Field Summary

Fields

Modifier and Type	Field	Description
private String	value	The same-site attribute value.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SameSiteValue(String attrValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Get the same-site attribute value.
static SameSiteCookieHeaderFilter.SameSiteValue	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SameSiteCookieHeaderFilter.SameSiteValue[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Strict

public static final SameSiteCookieHeaderFilter.SameSiteValue Strict

Send the cookie for 'same-site' requests only.

Lax

public static final SameSiteCookieHeaderFilter.SameSiteValue Lax

Send the cookie for 'same-site' requests along with 'cross-site' top level navigations using safe HTTP methods (GET, HEAD, OPTIONS, and TRACE).

None

public static final SameSiteCookieHeaderFilter.SameSiteValue None

Send the cookie for 'same-site' and 'cross-site' requests.

Null

public static final SameSiteCookieHeaderFilter.SameSiteValue Null

Specify nothing.

Field Detail

value

@Nonnull
@NotEmpty
private String value

The same-site attribute value.

Constructor Detail

SameSiteValue

private SameSiteValue(@Nonnull @NotEmpty
                      String attrValue)

Constructor.

Parameters:

attrValue - the same-site attribute value.

Method Detail

values

public static SameSiteCookieHeaderFilter.SameSiteValue[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SameSiteCookieHeaderFilter.SameSiteValue c : SameSiteCookieHeaderFilter.SameSiteValue.values())
    System.out.println(c);

Returns:

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

valueOf

public static SameSiteCookieHeaderFilter.SameSiteValue valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Get the same-site attribute value.

Returns:

Returns the value.