Class MockCookie

java.lang.Object
jakarta.servlet.http.Cookie
org.springframework.mock.web.MockCookie
All Implemented Interfaces:
Serializable, Cloneable

public class MockCookie extends Cookie
Extension of Cookie with extra attributes, as defined in RFC 6265.

As of Spring 6.0, this set of mocks is designed on a Servlet 6.0 baseline.

Since:
5.1
Author:
Vedran Pavic, Juergen Hoeller, Sam Brannen
See Also:
  • Constructor Details

  • Method Details

    • setExpires

      public void setExpires(@Nullable ZonedDateTime expires)
      Set the "Expires" attribute for this cookie.
      Since:
      5.1.11
    • getExpires

      @Nullable public ZonedDateTime getExpires()
      Get the "Expires" attribute for this cookie.
      Returns:
      the "Expires" attribute for this cookie, or null if not set
      Since:
      5.1.11
    • setSameSite

      public void setSameSite(@Nullable String sameSite)
      Set the "SameSite" attribute for this cookie.

      This limits the scope of the cookie such that it will only be attached to same-site requests if the supplied value is "Strict" or cross-site requests if the supplied value is "Lax".

      See Also:
    • getSameSite

      @Nullable public String getSameSite()
      Get the "SameSite" attribute for this cookie.
      Returns:
      the "SameSite" attribute for this cookie, or null if not set
    • parse

      public static MockCookie parse(String setCookieHeader)
      Factory method that parses the value of the supplied "Set-Cookie" header.
      Parameters:
      setCookieHeader - the "Set-Cookie" value; never null or empty
      Returns:
      the created cookie
    • setAttribute

      public void setAttribute(String name, @Nullable String value)
      Overrides:
      setAttribute in class Cookie
    • toString

      public String toString()
      Overrides:
      toString in class Cookie