Package io.javalin.http

Enum SameSite

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum SameSite
extends Enum<SameSite>

    Value to define the SameSite property of a cookie.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      NONE

      Means that the browser sends the cookie with both cross-site and same-site requests.
      STRICT

      Means that the browser sends the cookie only for same-site requests, that is, requests originating from the same site that set the cookie. If a request originates from a different domain or scheme (even with the same domain), no cookies with the SameSite=Strict attribute are sent.
      LAX

      Means that the cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site (for example, when following a link). This is the default behavior if the SameSite attribute is not specified.

    • Method Summary

      Modifier and Type Method Description
      String toString()
      final SameSite valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<SameSite> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final String getValue()
      final EnumEntries<SameSite> getEntries() Value to define the SameSite property of a cookie.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • valueOf

         final SameSite valueOf(String value)

        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.)

      • values

         final Array<SameSite> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.