ResponseCookie (Spring Framework 6.0.11 API)

link之家

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

See Also:


    
     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.


    
     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
    
    ()

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.

isHttpOnly

public boolean isHttpOnly ()

Return


    true

if the cookie has the "HttpOnly" attribute.

mutate

public ResponseCookie.ResponseCookieBuilder mutate ()

Return a builder pre-populated with values from


    "this"

instance.

Since:

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.

Parameters:


    name

- the cookie name

Returns:

a builder to create the cookie with

Since:

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.

Parameters:


    name

- the cookie name


    value

- the cookie value

Returns:

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.

Parameters:


    name

- the cookie name


    value

- the cookie value

Returns:

a builder to create the cookie with

Since:

5.2.5