Enum SameSiteCookies

java.lang.Object
java.lang.Enum<SameSiteCookies>
org.apache.tomcat.util.http.SameSiteCookies
All Implemented Interfaces:
Serializable, Comparable<SameSiteCookies>, java.lang.constant.Constable
public enum SameSiteCookies extends Enum<SameSiteCookies>
Defines the possible values for the SameSite cookie attribute.

  • Enum Constant Details

    • UNSET

      public static final SameSiteCookies UNSET
      Don't set the SameSite cookie attribute.

    • NONE

      public static final SameSiteCookies NONE
      Cookie is always sent in cross-site requests.

    • LAX

      public static final SameSiteCookies LAX
      Cookie is only sent on same-site requests and cross-site top level navigation GET requests

    • STRICT

      public static final SameSiteCookies STRICT
      Prevents the cookie from being sent by the browser in all cross-site requests

  • Method Details

    • values

      public static SameSiteCookies[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SameSiteCookies 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()
      Returns the string value of this SameSite setting.
      Returns:
      the SameSite value string

    • fromString

      public static SameSiteCookies fromString(String value)
      Converts a string value to the corresponding SameSiteCookies enum constant.
      Parameters:
      value - the string representation of the SameSite value
      Returns:
      the matching SameSiteCookies enum constant
      Throws:
      IllegalStateException - if the value does not match any known SameSite value