程序包 cn.taketoday.http

类 ResponseCookie

java.lang.Object

cn.taketoday.http.HttpCookie

cn.taketoday.http.ResponseCookie

public final class ResponseCookie
extends HttpCookie

An HttpCookie subclass with the additional attributes allowed in the "Set-Cookie" response header. To build an instance use the from(java.lang.String) static method.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Brian Clozel

另请参阅:

• RFC 6265

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	ResponseCookie.DefaultResponseCookieBuilder	Default implementation of ResponseCookie.ResponseCookieBuilder.
static interface	ResponseCookie.ResponseCookieBuilder	A builder for a server-defined HttpCookie with attributes.
private static class	ResponseCookie.Rfc6265Utils

字段概要

字段

修饰符和类型	字段	说明
private final String	domain
private final boolean	httpOnly
private final Duration	maxAge
private final String	path
private final String	sameSite
private final boolean	secure

构造器概要

构造器

限定符	构造器	说明
private	ResponseCookie(String name, String value, Duration maxAge, String domain, String path, boolean secure, boolean httpOnly, String sameSite)	Private constructor.

方法概要

修饰符和类型	方法	说明
boolean	equals(Object other)
static ResponseCookie.ResponseCookieBuilder	from(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.
static ResponseCookie.ResponseCookieBuilder	from(String name, 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.
static ResponseCookie.ResponseCookieBuilder	fromClientResponse(String name, String value)	Factory method to obtain a builder for a server-defined cookie.
String	getDomain()	Return the cookie "Domain" attribute, or null if not set.
Duration	getMaxAge()	Return the cookie "Max-Age" attribute in seconds.
String	getPath()	Return the cookie "Path" attribute, or null if not set.
String	getSameSite()	Return the cookie "SameSite" attribute, or null if not set.
int	hashCode()
boolean	isHttpOnly()	Return true if the cookie has the "HttpOnly" attribute.
boolean	isSecure()	Return true if the cookie has the "Secure" attribute.
ResponseCookie.ResponseCookieBuilder	mutate()	Return a builder pre-populated with values from "this" instance.
String	toString()

从类继承的方法 cn.taketoday.http.HttpCookie

getName, getValue

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

maxAge

private final Duration maxAge

domain

@Nullable
private final String domain

path

@Nullable
private final String path

secure

private final boolean secure

httpOnly

private final boolean httpOnly

sameSite

@Nullable
private final String sameSite

构造器详细资料

ResponseCookie

private ResponseCookie(String name,
 @Nullable
 String value,
 Duration maxAge,
 @Nullable
 String domain,
 @Nullable
 String path,
 boolean secure,
 boolean httpOnly,
 @Nullable
 String sameSite)

Private constructor. See from(String, String).

方法详细资料

getMaxAge

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.

getDomain

@Nullable
public String getDomain()

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

getPath

@Nullable
public String getPath()

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

isSecure

public boolean isSecure()

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

isHttpOnly

public boolean isHttpOnly()

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

另请参阅:

• https://www.owasp.org/index.php/HTTPOnly

getSameSite

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

另请参阅:

• RFC6265 bis

mutate

public ResponseCookie.ResponseCookieBuilder mutate()

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

equals

public boolean equals(@Nullable
 Object other)

覆盖:

equals 在类中 HttpCookie

hashCode

public int hashCode()

覆盖:

hashCode 在类中 HttpCookie

toString

public String toString()

覆盖:

toString 在类中 HttpCookie

from

public static ResponseCookie.ResponseCookieBuilder from(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.

参数:

name - the cookie name

返回:

a builder to create the cookie with

from

public static ResponseCookie.ResponseCookieBuilder from(String name,
 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.

参数:

name - the cookie name

value - the cookie value

返回:

a builder to create the cookie with

fromClientResponse

public static ResponseCookie.ResponseCookieBuilder fromClientResponse(String name,
 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.

参数:

name - the cookie name

value - the cookie value

返回:

a builder to create the cookie with