Enum CookieSameSite

java.lang.Object
java.lang.Enum<CookieSameSite>
io.vertx.core.http.CookieSameSite
All Implemented Interfaces:
Serializable, Comparable<CookieSameSite>
public enum CookieSameSite extends Enum<CookieSameSite>
Represents the Cookie SameSite policy to be used. For more info https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies.
Author:
Paulo Lopes

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    LAX
    Same-site cookies are withheld on cross-site subrequests, such as calls to load images or frames, but will be sent when a user navigates to the URL from an external site; for example, by following a link.
    NONE
    The browser will send cookies with both cross-site requests and same-site requests.
    STRICT
    The browser will only send cookies for same-site requests (requests originating from the site that set the cookie).

  • Method Summary

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

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final CookieSameSite NONE
      The browser will send cookies with both cross-site requests and same-site requests.

    • STRICT

      public static final CookieSameSite STRICT
      The browser will only send cookies for same-site requests (requests originating from the site that set the cookie). If the request originated from a different URL than the URL of the current location, none of the cookies tagged with the Strict attribute will be included.

    • LAX

      public static final CookieSameSite LAX
      Same-site cookies are withheld on cross-site subrequests, such as calls to load images or frames, but will be sent when a user navigates to the URL from an external site; for example, by following a link.

  • Method Details

    • values

      public static CookieSameSite[] 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 CookieSameSite 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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<CookieSameSite>