Package org.eclipse.jetty.http

Class HttpCookie

java.lang.Object

org.eclipse.jetty.http.HttpCookie

public class HttpCookie
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpCookie.SameSite
static class	HttpCookie.SetCookieHttpField

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HTTP_ONLY_COMMENT	String used in the Comment attribute of HttpCookie, parsed with isHttpOnlyInComment(String), to support the HttpOnly attribute.
static final String	PARTITIONED_COMMENT	String used in the Comment attribute of HttpCookie, parsed with isPartitionedInComment(String), to support the Partitioned attribute.
static final String	SAME_SITE_DEFAULT_ATTRIBUTE	Name of context attribute with default SameSite cookie value
static final String	SAME_SITE_LAX_COMMENT
static final String	SAME_SITE_NONE_COMMENT
static final String	SAME_SITE_STRICT_COMMENT

Constructor Summary

Constructors

Constructor	Description
HttpCookie(String setCookie)
HttpCookie(String name, String value)
HttpCookie(String name, String value, long maxAge)
HttpCookie(String name, String value, String domain, String path)
HttpCookie(String name, String value, String domain, String path, long maxAge, boolean httpOnly, boolean secure)
HttpCookie(String name, String value, String domain, String path, long maxAge, boolean httpOnly, boolean secure, String comment, int version)
HttpCookie(String name, String value, String domain, String path, long maxAge, boolean httpOnly, boolean secure, String comment, int version, HttpCookie.SameSite sameSite)
HttpCookie(String name, String value, String domain, String path, long maxAge, boolean httpOnly, boolean secure, String comment, int version, HttpCookie.SameSite sameSite, boolean partitioned)

Method Summary

Modifier and Type	Method	Description
String	asString()
String	getComment()
static String	getCommentWithAttributes(String comment, boolean httpOnly, HttpCookie.SameSite sameSite)
static String	getCommentWithAttributes(String comment, boolean httpOnly, HttpCookie.SameSite sameSite, boolean partitioned)
static String	getCommentWithoutAttributes(String comment)
String	getDomain()
long	getMaxAge()
String	getName()
String	getPath()
String	getRFC2965SetCookie()
String	getRFC6265SetCookie()
HttpCookie.SameSite	getSameSite()
static HttpCookie.SameSite	getSameSiteDefault(Attributes contextAttributes)	Get the default value for SameSite cookie attribute, if one has been set for the given context.
static HttpCookie.SameSite	getSameSiteFromComment(String comment)
String	getSetCookie(CookieCompliance compliance)
String	getValue()
int	getVersion()
boolean	isExpired(long timeNanos)
boolean	isHttpOnly()
static boolean	isHttpOnlyInComment(String comment)
boolean	isPartitioned()
static boolean	isPartitionedInComment(String comment)
boolean	isSecure()

Methods inherited from class java.lang.Object

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

Field Details

HTTP_ONLY_COMMENT

public static final String HTTP_ONLY_COMMENT

String used in the Comment attribute of HttpCookie, parsed with isHttpOnlyInComment(String), to support the HttpOnly attribute.

See Also:

• Constant Field Values

PARTITIONED_COMMENT

public static final String PARTITIONED_COMMENT

String used in the Comment attribute of HttpCookie, parsed with isPartitionedInComment(String), to support the Partitioned attribute.

See Also:

• Constant Field Values

SAME_SITE_NONE_COMMENT

public static final String SAME_SITE_NONE_COMMENT

See Also:

• Constant Field Values

SAME_SITE_LAX_COMMENT

public static final String SAME_SITE_LAX_COMMENT

See Also:

• Constant Field Values

SAME_SITE_STRICT_COMMENT

public static final String SAME_SITE_STRICT_COMMENT

See Also:

• Constant Field Values

SAME_SITE_DEFAULT_ATTRIBUTE

public static final String SAME_SITE_DEFAULT_ATTRIBUTE

Name of context attribute with default SameSite cookie value

See Also:

• Constant Field Values

Constructor Details

HttpCookie

public HttpCookie(String name,
 String value)

HttpCookie

public HttpCookie(String name,
 String value,
 String domain,
 String path)

HttpCookie

public HttpCookie(String name,
 String value,
 long maxAge)

HttpCookie

public HttpCookie(String name,
 String value,
 String domain,
 String path,
 long maxAge,
 boolean httpOnly,
 boolean secure)

HttpCookie

public HttpCookie(String name,
 String value,
 String domain,
 String path,
 long maxAge,
 boolean httpOnly,
 boolean secure,
 String comment,
 int version)

HttpCookie

public HttpCookie(String name,
 String value,
 String domain,
 String path,
 long maxAge,
 boolean httpOnly,
 boolean secure,
 String comment,
 int version,
 HttpCookie.SameSite sameSite)

HttpCookie

public HttpCookie(String name,
 String value,
 String domain,
 String path,
 long maxAge,
 boolean httpOnly,
 boolean secure,
 String comment,
 int version,
 HttpCookie.SameSite sameSite,
 boolean partitioned)

HttpCookie

public HttpCookie(String setCookie)

Method Details

getName

public String getName()

Returns:

the cookie name

getValue

public String getValue()

Returns:

the cookie value

getComment

public String getComment()

Returns:

the cookie comment

getDomain

public String getDomain()

Returns:

the cookie domain

getMaxAge

public long getMaxAge()

Returns:

the cookie max age in seconds

getPath

public String getPath()

Returns:

the cookie path

isSecure

public boolean isSecure()

Returns:

whether the cookie is valid for secure domains

getVersion

public int getVersion()

Returns:

the cookie version

getSameSite

public HttpCookie.SameSite getSameSite()

Returns:

the cookie SameSite enum attribute

isHttpOnly

public boolean isHttpOnly()

Returns:

whether the cookie is valid for the http protocol only

isExpired

public boolean isExpired(long timeNanos)

Parameters:

timeNanos - the time to check for cookie expiration, in nanoseconds

Returns:

whether the cookie is expired by the given time

isPartitioned

public boolean isPartitioned()

Returns:

whether this cookie is partitioned

asString

public String asString()

Returns:

a string representation of this cookie

getSetCookie

public String getSetCookie(CookieCompliance compliance)

getRFC2965SetCookie

public String getRFC2965SetCookie()

getRFC6265SetCookie

public String getRFC6265SetCookie()

isHttpOnlyInComment

public static boolean isHttpOnlyInComment(String comment)

isPartitionedInComment

public static boolean isPartitionedInComment(String comment)

getSameSiteFromComment

public static HttpCookie.SameSite getSameSiteFromComment(String comment)

getSameSiteDefault

public static HttpCookie.SameSite getSameSiteDefault(Attributes contextAttributes)

Get the default value for SameSite cookie attribute, if one has been set for the given context.

Parameters:

contextAttributes - the context to check for default SameSite value

Returns:

the default SameSite value or null if one does not exist

Throws:

IllegalStateException - if the default value is not a permitted value

getCommentWithoutAttributes

public static String getCommentWithoutAttributes(String comment)

getCommentWithAttributes

public static String getCommentWithAttributes(String comment,
 boolean httpOnly,
 HttpCookie.SameSite sameSite)

getCommentWithAttributes

public static String getCommentWithAttributes(String comment,
 boolean httpOnly,
 HttpCookie.SameSite sameSite,
 boolean partitioned)