Modifier and Type	Class and Description
private static class	ResponseCookie.DefaultResponseCookieBuilder Default implementation of `ResponseCookieBuilder`.
public static interface	ResponseCookie.ResponseCookieBuilder A builder for a server-defined HttpCookie with attributes.
private static class	ResponseCookie.Rfc6265Utils

Modifier and Type	Field and Description
private final String	domain
private final boolean	httpOnly
private final Duration	maxAge
private final String	path
private final String	sameSite
private final boolean	secure

Access	Constructor and Description
private	ResponseCookie(String name, String value, Duration maxAge, String domain, String path, boolean secure, boolean httpOnly, String sameSite) Private constructor.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides org.springframework.http.HttpCookie.equals. Indicates whether some other object is "equal to" this one.
public static ResponseCookie.ResponseCookieBuilder	Returns: a builder to create the cookie with from(final String the cookie name name) Factory method to obtain a builder for a server-defined cookie, given its name only, and where the value as well as other attributes can be set later via builder methods.
public static ResponseCookie.ResponseCookieBuilder	Returns: a builder to create the cookie with from(final String the cookie name name, final String the cookie value value) Factory method to obtain a builder for a server-defined cookie that starts with a name-value pair and may also include attributes.
public static ResponseCookie.ResponseCookieBuilder	Returns: a builder to create the cookie with fromClientResponse(final String the cookie name name, final String the cookie value value) Factory method to obtain a builder for a server-defined cookie.
public String	getDomain() Return the cookie "Domain" attribute, or `null` if not set.
public Duration	getMaxAge() Return the cookie "Max-Age" attribute in seconds.
public String	getPath() Return the cookie "Path" attribute, or `null` if not set.
public String	getSameSite() Return the cookie "SameSite" attribute, or `null` if not set.
public int	hashCode() Overrides org.springframework.http.HttpCookie.hashCode. Returns a hash code value for this object.
public boolean	isHttpOnly() Return `true` if the cookie has the "HttpOnly" attribute.
public boolean	isSecure() Return `true` if the cookie has the "Secure" attribute.
public ResponseCookie.ResponseCookieBuilder	mutate() Return a builder pre-populated with values from `"this"` instance.
public String	toString() Overrides org.springframework.http.HttpCookie.toString. Returns a string representation of the object.

Inherited from org.springframework.http.HttpCookie:: getName getValue

Field Detail

domain	back to summary
private final String domain Annotations @Nullable

httpOnly	back to summary
private final boolean httpOnly

maxAge	back to summary
private final Duration maxAge

path	back to summary
private final String path Annotations @Nullable

sameSite	back to summary
private final String sameSite Annotations @Nullable

secure	back to summary
private final boolean secure

Constructor Detail

ResponseCookie	back to summary
private ResponseCookie(String name, String value, Duration maxAge, String domain, String path, boolean secure, boolean httpOnly, String sameSite) Private constructor. See `from(String, String)`.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides org.springframework.http.HttpCookie.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides org.springframework.http.HttpCookie.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

from	back to summary
public static ResponseCookie.ResponseCookieBuilder from(final String name) Factory method to obtain a builder for a server-defined cookie, given its name only, and where the value as well as other attributes can be set later via builder methods. Parameters name:String the cookie name Returns:ResponseCookie.ResponseCookieBuilder a builder to create the cookie with Since 6.0

from

back to summary

public static ResponseCookie.ResponseCookieBuilder from(final String name)

Factory method to obtain a builder for a server-defined cookie, given its name only, and where the value as well as other attributes can be set later via builder methods.

Parameters

name:String: the cookie name

Returns:ResponseCookie.ResponseCookieBuilder

a builder to create the cookie with

Since

6.0

from	back to summary
public static ResponseCookie.ResponseCookieBuilder from(final String name, final String value) Factory method to obtain a builder for a server-defined cookie that starts with a name-value pair and may also include attributes. Parameters name:String the cookie name value:String the cookie value Returns:ResponseCookie.ResponseCookieBuilder a builder to create the cookie with

from

back to summary

public static ResponseCookie.ResponseCookieBuilder from(final String name, final String value)

Factory method to obtain a builder for a server-defined cookie that starts with a name-value pair and may also include attributes.

Parameters

name:String: the cookie name
value:String: the cookie value

Returns:ResponseCookie.ResponseCookieBuilder

a builder to create the cookie with

fromClientResponse back to summary

fromClientResponse	back to summary
public static ResponseCookie.ResponseCookieBuilder fromClientResponse(final String name, final String value) Factory method to obtain a builder for a server-defined cookie. Unlike `from(String, String)` this option assumes input from a remote server, which can be handled more leniently, e.g. ignoring an empty domain name with double quotes. Parameters name:String the cookie name value:String the cookie value Returns:ResponseCookie.ResponseCookieBuilder a builder to create the cookie with Since 5.2.5

public static ResponseCookie.ResponseCookieBuilder fromClientResponse(final String name, final String value)

Factory method to obtain a builder for a server-defined cookie. Unlike from(String, String) this option assumes input from a remote server, which can be handled more leniently, e.g. ignoring an empty domain name with double quotes.

Parameters

name:String: the cookie name
value:String: the cookie value

Returns:ResponseCookie.ResponseCookieBuilder

a builder to create the cookie with

Since

5.2.5

getDomain back to summary

getDomain	back to summary
public String getDomain() Return the cookie "Domain" attribute, or `null` if not set. Annotations @Nullable

public String getDomain()

Return the cookie "Domain" attribute, or null if not set.

Annotations

@Nullable

getMaxAge	back to summary
public Duration getMaxAge() Return the cookie "Max-Age" attribute in seconds. A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age" attribute in which case the cookie is removed when the browser is closed.

getMaxAge

back to summary

public Duration getMaxAge()

Return the cookie "Max-Age" attribute in seconds.

A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age" attribute in which case the cookie is removed when the browser is closed.

getPath back to summary

getPath	back to summary
public String getPath() Return the cookie "Path" attribute, or `null` if not set. Annotations @Nullable

public String getPath()

Return the cookie "Path" attribute, or null if not set.

Annotations

@Nullable

getSameSite back to summary

getSameSite	back to summary
public String getSameSite() Return the cookie "SameSite" attribute, or `null` if not set. 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"`. Annotations @Nullable Since 5.1 See Also RFC6265 bis

public String getSameSite()

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

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

Annotations

@Nullable

Since

5.1

See Also

RFC6265 bis

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.springframework.http.HttpCookie.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides org.springframework.http.HttpCookie.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isHttpOnly back to summary

isHttpOnly	back to summary
public boolean isHttpOnly() Return `true` if the cookie has the "HttpOnly" attribute. See Also https://www.owasp.org/index.php/HTTPOnly

public boolean isHttpOnly()

Return true if the cookie has the "HttpOnly" attribute.

See Also: https://www.owasp.org/index.php/HTTPOnly

isSecure	back to summary
public boolean isSecure() Return `true` if the cookie has the "Secure" attribute.

mutate back to summary

mutate	back to summary
public ResponseCookie.ResponseCookieBuilder mutate() Return a builder pre-populated with values from `"this"` instance. Since 6.0

public ResponseCookie.ResponseCookieBuilder mutate()

Return a builder pre-populated with values from "this" instance.

Since: 6.0

toString back to summary

toString	back to summary
public String toString() Overrides org.springframework.http.HttpCookie.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.springframework.http.HttpCookie.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Modifier and Type	Field and Description
private String	domain
private boolean	httpOnly
private final boolean	lenient
private Duration	maxAge
private final String	name
private String	path
private String	sameSite
private boolean	secure
private String	value

Access	Constructor and Description
public	DefaultResponseCookieBuilder(String name, String value, boolean lenient)

Modifier and Type	Method and Description
public ResponseCookie	build() Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.build. Create the HttpCookie.
public ResponseCookie.ResponseCookieBuilder	domain(String domain) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.domain. Set the cookie "Domain" attribute.
public ResponseCookie.ResponseCookieBuilder	httpOnly(boolean httpOnly) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.httpOnly. Add the "HttpOnly" attribute to the cookie.
private String	initDomain(String domain)
public ResponseCookie.ResponseCookieBuilder	maxAge(Duration maxAge) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.maxAge. Set the cookie "Max-Age" attribute.
public ResponseCookie.ResponseCookieBuilder	maxAge(long maxAgeSeconds) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.maxAge. Variant of `maxAge(Duration)` accepting a value in seconds.
public ResponseCookie.ResponseCookieBuilder	path(String path) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.path. Set the cookie "Path" attribute.
public ResponseCookie.ResponseCookieBuilder	sameSite(String sameSite) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.sameSite. Add the "SameSite" attribute to the cookie.
public ResponseCookie.ResponseCookieBuilder	secure(boolean secure) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.secure. Add the "Secure" attribute to the cookie.
public ResponseCookie.ResponseCookieBuilder	value(String value) Implements org.springframework.http.ResponseCookie.ResponseCookieBuilder.value. Set the cookie value.

org.springframework.http back to summary

public Interface ResponseCookie.ResponseCookieBuilder

Known Direct Implementers: org.springframework.http.ResponseCookie.DefaultResponseCookieBuilder

A builder for a server-defined HttpCookie with attributes.

Method Summary

Modifier and Type	Method and Description
public ResponseCookie	build() Create the HttpCookie.
public ResponseCookie.ResponseCookieBuilder	domain(String domain) Set the cookie "Domain" attribute.
public ResponseCookie.ResponseCookieBuilder	httpOnly(boolean httpOnly) Add the "HttpOnly" attribute to the cookie.
public ResponseCookie.ResponseCookieBuilder	maxAge(Duration maxAge) Set the cookie "Max-Age" attribute.
public ResponseCookie.ResponseCookieBuilder	maxAge(long maxAgeSeconds) Variant of `maxAge(Duration)` accepting a value in seconds.
public ResponseCookie.ResponseCookieBuilder	path(String path) Set the cookie "Path" attribute.
public ResponseCookie.ResponseCookieBuilder	sameSite(String sameSite) Add the "SameSite" attribute to the cookie.
public ResponseCookie.ResponseCookieBuilder	secure(boolean secure) Add the "Secure" attribute to the cookie.
public ResponseCookie.ResponseCookieBuilder	value(String value) Set the cookie value.

Method Detail

build	back to summary
public ResponseCookie build() Create the HttpCookie.

domain	back to summary
public ResponseCookie.ResponseCookieBuilder domain(String domain) Set the cookie "Domain" attribute.

httpOnly

back to summary

public ResponseCookie.ResponseCookieBuilder httpOnly(boolean httpOnly)

Add the "HttpOnly" attribute to the cookie.

See Also: https://www.owasp.org/index.php/HTTPOnly

maxAge

back to summary

public ResponseCookie.ResponseCookieBuilder maxAge(Duration maxAge)

Set the cookie "Max-Age" attribute.

A positive value indicates when the cookie should expire relative to the current time. A value of 0 means the cookie should expire immediately. A negative value results in no "Max-Age" attribute in which case the cookie is removed when the browser is closed.

maxAge	back to summary
public ResponseCookie.ResponseCookieBuilder maxAge(long maxAgeSeconds) Variant of `maxAge(Duration)` accepting a value in seconds.

path	back to summary
public ResponseCookie.ResponseCookieBuilder path(String path) Set the cookie "Path" attribute.

sameSite back to summary

public ResponseCookie.ResponseCookieBuilder sameSite(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".

Since: 5.1
See Also: RFC6265 bis

secure	back to summary
public ResponseCookie.ResponseCookieBuilder secure(boolean secure) Add the "Secure" attribute to the cookie.

value

back to summary

public ResponseCookie.ResponseCookieBuilder value(String value)

Set the cookie value.

Since: 6.0

Modifier and Type	Field and Description
private static final String	DOMAIN_CHARS
private static final String	SEPARATOR_CHARS

Modifier and Type	Method and Description
public static void	validateCookieName(String name)
public static void	validateCookieValue(String value)
public static void	validateDomain(String domain)
public static void	validatePath(String path)

public final Class ResponseCookie

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ResponseCookie.DefaultResponseCookieBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ResponseCookie.ResponseCookieBuilder

Method Summary

Method Detail

private Class ResponseCookie.Rfc6265Utils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail