程序包 cn.taketoday.web.servlet

类 CookieGenerator

java.lang.Object

cn.taketoday.web.servlet.CookieGenerator

直接已知子类:

CookieLocaleResolver

public class CookieGenerator
extends Object

Helper class for cookie generation, carrying cookie descriptor settings as bean properties and being able to add and remove cookie to/from a given response.

从以下版本开始:

4.0

作者:

Juergen Hoeller

另请参阅:

• addCookie(cn.taketoday.web.RequestContext, java.lang.String)
• removeCookie(cn.taketoday.web.RequestContext)

字段概要

字段

修饰符和类型	字段	说明
private String	cookieDomain
private boolean	cookieHttpOnly
private Integer	cookieMaxAge
private String	cookieName
private String	cookiePath
private String	cookieSameSite
private boolean	cookieSecure
static final String	DEFAULT_COOKIE_PATH	Default path that cookies will be visible to: "/", i.e. the entire server.
protected final cn.taketoday.logging.Logger	logger

构造器概要

构造器

构造器	说明
CookieGenerator()

方法概要

修饰符和类型	方法	说明
void	addCookie(RequestContext response, String cookieValue)	Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.
protected ResponseCookie.ResponseCookieBuilder	createCookie(String cookieValue)	Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
String	getCookieDomain()	Return the domain for cookies created by this generator, if any.
Integer	getCookieMaxAge()	Return the maximum age for cookies created by this generator.
String	getCookieName()	Return the given name for cookies created by this generator.
String	getCookiePath()	Return the path for cookies created by this generator.
String	getCookieSameSite()
boolean	isCookieHttpOnly()	Return whether the cookie is supposed to be marked with the "HttpOnly" attribute.
boolean	isCookieSecure()	Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).
void	removeCookie(RequestContext response)	Remove the cookie that this generator describes from the response.
void	setCookieDomain(String cookieDomain)	Use the given domain for cookies created by this generator.
void	setCookieHttpOnly(boolean cookieHttpOnly)	Set whether the cookie is supposed to be marked with the "HttpOnly" attribute.
void	setCookieMaxAge(Integer cookieMaxAge)	Use the given maximum age (in seconds) for cookies created by this generator.
void	setCookieName(String cookieName)	Use the given name for cookies created by this generator.
void	setCookiePath(String cookiePath)	Use the given path for cookies created by this generator.
void	setCookieSameSite(String cookieSameSite)	Add the "SameSite" attribute to the cookie.
void	setCookieSecure(boolean cookieSecure)	Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).

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

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

字段详细资料

DEFAULT_COOKIE_PATH

public static final String DEFAULT_COOKIE_PATH

Default path that cookies will be visible to: "/", i.e. the entire server.

另请参阅:

• 常量字段值

logger

protected final cn.taketoday.logging.Logger logger

cookieName

@Nullable
private String cookieName

cookieDomain

@Nullable
private String cookieDomain

cookiePath

private String cookiePath

cookieMaxAge

@Nullable
private Integer cookieMaxAge

cookieSecure

private boolean cookieSecure

cookieHttpOnly

private boolean cookieHttpOnly

cookieSameSite

@Nullable
private String cookieSameSite

构造器详细资料

CookieGenerator

public CookieGenerator()

方法详细资料

setCookieName

public void setCookieName(@Nullable
 String cookieName)

Use the given name for cookies created by this generator.

另请参阅:

• HttpCookie.getName()

getCookieName

@Nullable
public String getCookieName()

Return the given name for cookies created by this generator.

setCookieDomain

public void setCookieDomain(@Nullable
 String cookieDomain)

Use the given domain for cookies created by this generator. The cookie is only visible to servers in this domain.

另请参阅:

• ResponseCookie.ResponseCookieBuilder.domain(java.lang.String)

getCookieDomain

@Nullable
public String getCookieDomain()

Return the domain for cookies created by this generator, if any.

setCookiePath

public void setCookiePath(String cookiePath)

Use the given path for cookies created by this generator. The cookie is only visible to URLs in this path and below.

另请参阅:

• ResponseCookie.ResponseCookieBuilder.path(java.lang.String)

getCookiePath

public String getCookiePath()

Return the path for cookies created by this generator.

setCookieMaxAge

public void setCookieMaxAge(@Nullable
 Integer cookieMaxAge)

Use the given maximum age (in seconds) for cookies created by this generator. Useful special value: -1 ... not persistent, deleted when client shuts down.

Default is no specific maximum age at all, using the Servlet container's default.

另请参阅:

• ResponseCookie.ResponseCookieBuilder.maxAge(java.time.Duration)

getCookieMaxAge

@Nullable
public Integer getCookieMaxAge()

Return the maximum age for cookies created by this generator.

setCookieSecure

public void setCookieSecure(boolean cookieSecure)

Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL). This is an indication to the receiving browser, not processed by the HTTP server itself.

Default is "false".

另请参阅:

• ResponseCookie.ResponseCookieBuilder.secure(boolean)

isCookieSecure

public boolean isCookieSecure()

Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).

setCookieHttpOnly

public void setCookieHttpOnly(boolean cookieHttpOnly)

Set whether the cookie is supposed to be marked with the "HttpOnly" attribute.

Default is "false".

另请参阅:

• ResponseCookie.ResponseCookieBuilder.httpOnly(boolean)

setCookieSameSite

public void setCookieSameSite(String cookieSameSite)

Add the "SameSite" attribute to the cookie.

By default, this is set to "Lax".

另请参阅:

• ResponseCookie.ResponseCookieBuilder.sameSite(String)

getCookieSameSite

@Nullable
public String getCookieSameSite()

isCookieHttpOnly

public boolean isCookieHttpOnly()

Return whether the cookie is supposed to be marked with the "HttpOnly" attribute.

addCookie

public void addCookie(RequestContext response,
 String cookieValue)

Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.

Delegates to createCookie(java.lang.String) for cookie creation.

参数:

response - the HTTP response to add the cookie to

cookieValue - the value of the cookie to add

另请参阅:

• setCookieName(java.lang.String)
• setCookieDomain(java.lang.String)
• setCookiePath(java.lang.String)
• setCookieMaxAge(java.lang.Integer)

removeCookie

public void removeCookie(RequestContext response)

Remove the cookie that this generator describes from the response. Will generate a cookie with empty value and max age 0.

Delegates to createCookie(java.lang.String) for cookie creation.

参数:

response - the HTTP response to remove the cookie from

另请参阅:

• setCookieName(java.lang.String)
• setCookieDomain(java.lang.String)
• setCookiePath(java.lang.String)

createCookie

protected ResponseCookie.ResponseCookieBuilder createCookie(String cookieValue)

Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").

参数:

cookieValue - the value of the cookie to crate

返回:

the cookie

另请参阅:

• setCookieName(java.lang.String)
• setCookieDomain(java.lang.String)
• setCookiePath(java.lang.String)