org.springframework.mock.web

Class MockCookie

java.lang.Object

javax.servlet.http.Cookie

org.springframework.mock.web.MockCookie

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MockCookie
extends Cookie

Extension of Cookie with extra attributes, as defined in RFC 6265.

Since:

5.1

Author:

Vedran Pavic

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MockCookie(java.lang.String name, java.lang.String value) Constructor with the cookie name and value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSameSite() Return the "SameSite" attribute, or null if not set.
static MockCookie	parse(java.lang.String setCookieHeader) Factory method that parses the value of a "Set-Cookie" header.
void	setSameSite(java.lang.String sameSite) Add the "SameSite" attribute to the cookie.

Methods inherited from class javax.servlet.http.Cookie

clone, getComment, getDomain, getMaxAge, getName, getPath, getSecure, getValue, getVersion, isHttpOnly, setComment, setDomain, setHttpOnly, setMaxAge, setPath, setSecure, setValue, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

MockCookie

public MockCookie(java.lang.String name,
                  java.lang.String value)

Constructor with the cookie name and value.

Parameters:

name - the name

value - the value

See Also:

Cookie.Cookie(String, String)

Method Detail

setSameSite

public void setSameSite(@Nullable
                        java.lang.String sameSite)

Add the "SameSite" attribute to the cookie.

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

See Also:

RFC6265 bis

getSameSite

@Nullable
public java.lang.String getSameSite()

Return the "SameSite" attribute, or null if not set.

parse

public static MockCookie parse(java.lang.String setCookieHeader)

Factory method that parses the value of a "Set-Cookie" header.

Parameters:

setCookieHeader - the "Set-Cookie" value; never null or empty

Returns:

the created cookie