Package org.apache.tomcat.util.http

Enum SameSiteCookies

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SameSiteCookies>
    public enum SameSiteCookies
extends java.lang.Enum<SameSiteCookies>
    Defines the possible values for the SameSite cookie attribute.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LAX
      Cookie is only sent on same-site requests and cross-site top level navigation GET requests
      NONE
      Cookie is always sent in cross-site requests.
      STRICT
      Prevents the cookie from being sent by the browser in all cross-site requests
      UNSET
      Don't set the SameSite cookie attribute.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SameSiteCookies fromString​(java.lang.String value)
      Converts a string value to the corresponding SameSiteCookies enum constant.
      java.lang.String getValue()
      Returns the string value of this SameSite setting.
      static SameSiteCookies valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SameSiteCookies[] 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

      • 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 Detail

      • values

        public static SameSiteCookies[] 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 (SameSiteCookies c : SameSiteCookies.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SameSiteCookies valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getValue

        public java.lang.String getValue()
        Returns the string value of this SameSite setting.
        Returns:
        the SameSite value string

      • fromString

        public static SameSiteCookies fromString​(java.lang.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:
        java.lang.IllegalStateException - if the value does not match any known SameSite value