Class CookieResultMatchers

java.lang.Object

org.springframework.test.web.servlet.result.CookieResultMatchers

public class CookieResultMatchers
extends Object

Factory for response cookie assertions.

An instance of this class is typically accessed via MockMvcResultMatchers.cookie().

Since:

3.2

Author:

Rossen Stoyanchev, Thomas Bruyelle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CookieResultMatchers()	Protected constructor.

Method Summary

Modifier and Type	Method	Description
ResultMatcher	attribute(String cookieName, String cookieAttribute, String attributeValue)	Assert a cookie's specified attribute.
ResultMatcher	attribute(String cookieName, String cookieAttribute, Matcher<? super String> matcher)	Assert a cookie's specified attribute with a Hamcrest Matcher.
ResultMatcher	comment(String name, String comment)	Assert a cookie's comment.
ResultMatcher	comment(String name, Matcher<? super String> matcher)	Assert a cookie's comment with a Hamcrest Matcher.
ResultMatcher	doesNotExist(String name)	Assert a cookie does not exist.
ResultMatcher	domain(String name, String domain)	Assert a cookie's domain.
ResultMatcher	domain(String name, Matcher<? super String> matcher)	Assert a cookie's domain with a Hamcrest Matcher.
ResultMatcher	exists(String name)	Assert a cookie exists.
ResultMatcher	httpOnly(String name, boolean httpOnly)	Assert whether the cookie must be HTTP only.
ResultMatcher	maxAge(String name, int maxAge)	Assert a cookie's maxAge.
ResultMatcher	maxAge(String name, Matcher<? super Integer> matcher)	Assert a cookie's maxAge with a Hamcrest Matcher.
ResultMatcher	partitioned(String name, boolean partitioned)	Assert whether the cookie is partitioned.
ResultMatcher	path(String name, String path)	Assert a cookie's path.
ResultMatcher	path(String name, Matcher<? super String> matcher)	Assert a cookie's path with a Hamcrest Matcher.
ResultMatcher	sameSite(String name, String sameSite)	Assert a cookie's SameSite attribute.
ResultMatcher	sameSite(String name, Matcher<? super String> matcher)	Assert a cookie's SameSite attribute with a Hamcrest Matcher.
ResultMatcher	secure(String name, boolean secure)	Assert whether the cookie must be sent over a secure protocol or not.
ResultMatcher	value(String name, String expectedValue)	Assert a cookie value.
ResultMatcher	value(String name, Matcher<? super String> matcher)	Assert a cookie value with the given Hamcrest Matcher.
ResultMatcher	version(String name, int version)	Assert a cookie's version.
ResultMatcher	version(String name, Matcher<? super Integer> matcher)	Assert a cookie's version with a Hamcrest Matcher.

Methods inherited from class Object

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

Constructor Details

CookieResultMatchers

protected CookieResultMatchers()

Protected constructor. Use MockMvcResultMatchers.cookie().

Method Details

value

public ResultMatcher value(String name,
 Matcher<? super String> matcher)

Assert a cookie value with the given Hamcrest Matcher.

value

public ResultMatcher value(String name,
 String expectedValue)

Assert a cookie value.

exists

public ResultMatcher exists(String name)

Assert a cookie exists. The existence check is irrespective of whether max age is 0 (i.e. expired).

doesNotExist

public ResultMatcher doesNotExist(String name)

Assert a cookie does not exist. Note that the existence check is irrespective of whether max age is 0, i.e. expired.

maxAge

public ResultMatcher maxAge(String name,
 Matcher<? super Integer> matcher)

Assert a cookie's maxAge with a Hamcrest Matcher.

maxAge

public ResultMatcher maxAge(String name,
 int maxAge)

Assert a cookie's maxAge.

path

public ResultMatcher path(String name,
 Matcher<? super String> matcher)

Assert a cookie's path with a Hamcrest Matcher.

path

public ResultMatcher path(String name,
 String path)

Assert a cookie's path.

domain

public ResultMatcher domain(String name,
 Matcher<? super String> matcher)

Assert a cookie's domain with a Hamcrest Matcher.

domain

public ResultMatcher domain(String name,
 String domain)

Assert a cookie's domain.

sameSite

public ResultMatcher sameSite(String name,
 Matcher<? super String> matcher)

Assert a cookie's SameSite attribute with a Hamcrest Matcher.

Since:

6.0.8

See Also:

• attribute(String, String, Matcher)

sameSite

public ResultMatcher sameSite(String name,
 String sameSite)

Assert a cookie's SameSite attribute.

Since:

6.0.8

See Also:

• attribute(String, String, String)

comment

public ResultMatcher comment(String name,
 Matcher<? super String> matcher)

Assert a cookie's comment with a Hamcrest Matcher.

comment

public ResultMatcher comment(String name,
 String comment)

Assert a cookie's comment.

version

public ResultMatcher version(String name,
 Matcher<? super Integer> matcher)

Assert a cookie's version with a Hamcrest Matcher.

version

public ResultMatcher version(String name,
 int version)

Assert a cookie's version.

secure

public ResultMatcher secure(String name,
 boolean secure)

Assert whether the cookie must be sent over a secure protocol or not.

httpOnly

public ResultMatcher httpOnly(String name,
 boolean httpOnly)

Assert whether the cookie must be HTTP only.

Since:

4.3.9

partitioned

public ResultMatcher partitioned(String name,
 boolean partitioned)

Assert whether the cookie is partitioned.

Since:

6.2

attribute

public ResultMatcher attribute(String cookieName,
 String cookieAttribute,
 Matcher<? super String> matcher)

Assert a cookie's specified attribute with a Hamcrest Matcher.

Parameters:

cookieAttribute - the name of the Cookie attribute (case-insensitive)

Since:

6.0.8

attribute

public ResultMatcher attribute(String cookieName,
 String cookieAttribute,
 String attributeValue)

Assert a cookie's specified attribute.

Parameters:

cookieAttribute - the name of the Cookie attribute (case-insensitive)

Since:

6.0.8