Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Interface HttpCookie

All Known Implementing Classes:

HttpCookie.Immutable, HttpCookie.JavaNetHttpCookie, HttpCookie.Wrapper

public interface HttpCookie

Implementation of RFC6265 HTTP Cookies (with fallback support for RFC2965).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpCookie.Builder	A builder for HttpCookie instances.
static class	HttpCookie.Immutable	Immutable implementation of HttpCookie.
static class	HttpCookie.JavaNetHttpCookie	A HttpCookie that wraps a HttpCookie.
static enum	HttpCookie.SameSite	The possible values for the SameSite attribute, defined in the follow-up of RFC 6265, at the time of this writing defined at RFC 6265bis.
static class	HttpCookie.Wrapper	A wrapper for HttpCookie instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMENT_ATTRIBUTE
static final String	DOMAIN_ATTRIBUTE
static final String	EXPIRES_ATTRIBUTE
static final String	HTTP_ONLY_ATTRIBUTE
static final String	MAX_AGE_ATTRIBUTE
static final String	PARTITIONED_ATTRIBUTE
static final String	PATH_ATTRIBUTE
static final String	SAME_SITE_ATTRIBUTE
static final String	SECURE_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
static HttpCookie	asJavaNetHttpCookie(HttpCookie httpCookie)	Converts a HttpCookie to a HttpCookie.
static HttpCookie.Builder	build(String name, String value)	Creates a HttpCookie.Builder to build a HttpCookie.
static HttpCookie.Builder	build(String name, String value, int version)	Creates a HttpCookie.Builder to build a HttpCookie.
static HttpCookie.Builder	build(HttpCookie httpCookie)	Creates a HttpCookie.Builder to build a HttpCookie.
static HttpCookie.Builder	build(HttpCookie httpCookie)	Creates a HttpCookie.Builder to build a HttpCookie.
boolean	equals(Object obj)
static boolean	equals(HttpCookie cookie1, Object obj)	Implementation of Object.equals(Object) compatible with RFC 6265.
static String	formatExpires(Instant expires)	Formats the Instant associated with the Expires attribute into a RFC 1123 string.
static HttpCookie	from(String name, String value)	Creates a new HttpCookie from the given name and value.
static HttpCookie	from(String name, String value, int version, Map<String,String> attributes)	Creates a new HttpCookie from the given name, value, version and attributes.
static HttpCookie	from(String name, String value, Map<String,String> attributes)	Creates a new HttpCookie from the given name, value and attributes.
static HttpCookie	from(HttpCookie httpCookie)	Creates a new HttpCookie copied from the given HttpCookie.
static HttpCookie	from(HttpCookie cookie, String... additionalAttributes)
Map<String,String>	getAttributes()
default String	getComment()	Equivalent to getAttributes().get(COMMENT_ATTRIBUTE).
default String	getDomain()	Equivalent to getAttributes().get(DOMAIN_ATTRIBUTE).
default Instant	getExpires()
default long	getMaxAge()
String	getName()
default String	getPath()	Equivalent to getAttributes().get(PATH_ATTRIBUTE).
default HttpCookie.SameSite	getSameSite()
String	getValue()
int	getVersion()
int	hashCode()
static int	hashCode(HttpCookie httpCookie)	Implementation of Object.hashCode() compatible with RFC 6265.
default boolean	isExpired()
default boolean	isHttpOnly()
default boolean	isPartitioned()
default boolean	isSecure()
static Instant	parseExpires(String expires)	Parses the Expires Date/Time attribute value into an Instant.
static String	toString(HttpCookie httpCookie)	Formats this cookie into a string suitable to be used for logging.

Field Details

COMMENT_ATTRIBUTE

static final String COMMENT_ATTRIBUTE

See Also:

• Constant Field Values

DOMAIN_ATTRIBUTE

static final String DOMAIN_ATTRIBUTE

See Also:

• Constant Field Values

EXPIRES_ATTRIBUTE

static final String EXPIRES_ATTRIBUTE

See Also:

• Constant Field Values

HTTP_ONLY_ATTRIBUTE

static final String HTTP_ONLY_ATTRIBUTE

See Also:

• Constant Field Values

MAX_AGE_ATTRIBUTE

static final String MAX_AGE_ATTRIBUTE

See Also:

• Constant Field Values

PATH_ATTRIBUTE

static final String PATH_ATTRIBUTE

See Also:

• Constant Field Values

SAME_SITE_ATTRIBUTE

static final String SAME_SITE_ATTRIBUTE

See Also:

• Constant Field Values

SECURE_ATTRIBUTE

static final String SECURE_ATTRIBUTE

See Also:

• Constant Field Values

PARTITIONED_ATTRIBUTE

static final String PARTITIONED_ATTRIBUTE

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns:

the cookie name

getValue

String getValue()

Returns:

the cookie value

getVersion

int getVersion()

Returns:

the value of the Version attribute

getAttributes

Map<String,String> getAttributes()

Returns:

the attributes associated with this cookie

getExpires

default Instant getExpires()

Returns:

the value of the Expires attribute, or null if not present

See Also:

• EXPIRES_ATTRIBUTE

getMaxAge

default long getMaxAge()

Returns:

the value of the Max-Age attribute, in seconds, or -1 if not present

See Also:

• MAX_AGE_ATTRIBUTE

isExpired

default boolean isExpired()

Returns:

whether the cookie is expired

getComment

default String getComment()

Equivalent to getAttributes().get(COMMENT_ATTRIBUTE).

Returns:

the value of the Comment attribute

See Also:

• COMMENT_ATTRIBUTE

getDomain

default String getDomain()

Equivalent to getAttributes().get(DOMAIN_ATTRIBUTE).

Returns:

the value of the Domain attribute

See Also:

• DOMAIN_ATTRIBUTE

getPath

default String getPath()

Equivalent to getAttributes().get(PATH_ATTRIBUTE).

Returns:

the value of the Path attribute

See Also:

• PATH_ATTRIBUTE

isSecure

default boolean isSecure()

Returns:

whether the Secure attribute is present

See Also:

• SECURE_ATTRIBUTE

getSameSite

default HttpCookie.SameSite getSameSite()

Returns:

the value of the SameSite attribute

See Also:

• SAME_SITE_ATTRIBUTE

isHttpOnly

default boolean isHttpOnly()

Returns:

whether the HttpOnly attribute is present

See Also:

• HTTP_ONLY_ATTRIBUTE

isPartitioned

default boolean isPartitioned()

Returns:

whether the Partitioned attribute is present

See Also:

• PARTITIONED_ATTRIBUTE

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

the cookie hash code

See Also:

• hashCode(HttpCookie)

equals

boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj - the object to test for equality

Returns:

whether this cookie is equal to the given object

See Also:

• equals(HttpCookie, Object)

from

static HttpCookie from(String name,
 String value)

Creates a new HttpCookie from the given name and value.

Parameters:

name - the name of the cookie

value - the value of the cookie

from

static HttpCookie from(String name,
 String value,
 Map<String,String> attributes)

Creates a new HttpCookie from the given name, value and attributes.

Parameters:

name - the name of the cookie

value - the value of the cookie

attributes - the map of attributes to use with this cookie (this map is used for field values such as getDomain(), getPath(), getMaxAge(), isHttpOnly(), isSecure(), isPartitioned(), getComment(), plus any newly defined attributes unknown to this code base.

from

static HttpCookie from(String name,
 String value,
 int version,
 Map<String,String> attributes)

Creates a new HttpCookie from the given name, value, version and attributes.

Parameters:

name - the name of the cookie

value - the value of the cookie

version - the version of the cookie (only used in RFC2965 mode)

attributes - the map of attributes to use with this cookie (this map is used for field values such as getDomain(), getPath(), getMaxAge(), isHttpOnly(), isSecure(), isPartitioned(), getComment(), plus any newly defined attributes unknown to this code base.

from

static HttpCookie from(HttpCookie cookie,
 String... additionalAttributes)

Parameters:

cookie - A cookie to base the new cookie on.

additionalAttributes - Additional name value pairs of strings to use as additional attributes

Returns:

A new cookie based on the passed cookie plus additional attributes.

from

static HttpCookie from(HttpCookie httpCookie)

Creates a new HttpCookie copied from the given HttpCookie.

Parameters:

httpCookie - the HttpCookie instance to copy

Returns:

a new HttpCookie copied from the HttpCookie

See Also:

• asJavaNetHttpCookie(HttpCookie)

build

static HttpCookie.Builder build(String name,
 String value)

Creates a HttpCookie.Builder to build a HttpCookie.

Parameters:

name - the cookie name

value - the cookie value

Returns:

a new HttpCookie.Builder initialized with the given values

build

static HttpCookie.Builder build(String name,
 String value,
 int version)

Creates a HttpCookie.Builder to build a HttpCookie.

Parameters:

name - the cookie name

value - the cookie value

version - the cookie version

Returns:

a new HttpCookie.Builder initialized with the given values

build

static HttpCookie.Builder build(HttpCookie httpCookie)

Creates a HttpCookie.Builder to build a HttpCookie.

Parameters:

httpCookie - the cookie to copy

Returns:

a new HttpCookie.Builder initialized with the given cookie

build

static HttpCookie.Builder build(HttpCookie httpCookie)

Creates a HttpCookie.Builder to build a HttpCookie.

Parameters:

httpCookie - the HttpCookie to copy

Returns:

a new HttpCookie.Builder initialized with the given cookie

asJavaNetHttpCookie

static HttpCookie asJavaNetHttpCookie(HttpCookie httpCookie)

Converts a HttpCookie to a HttpCookie.

Parameters:

httpCookie - the cookie to convert

Returns:

a new HttpCookie

See Also:

• from(java.net.HttpCookie)

hashCode

static int hashCode(HttpCookie httpCookie)

Implementation of Object.hashCode() compatible with RFC 6265.

Parameters:

httpCookie - the cookie to be hashed

Returns:

the hash code of the cookie

See Also:

• equals(HttpCookie, Object)

equals

static boolean equals(HttpCookie cookie1,
 Object obj)

Implementation of Object.equals(Object) compatible with RFC 6265.

Two cookies are equal if they have the same name (case-sensitive), the same domain (case-insensitive) and the same path (case-sensitive).

Parameters:

cookie1 - the first cookie to equal

obj - the second cookie to equal

Returns:

whether the cookies are equal

See Also:

• hashCode(HttpCookie)

toString

static String toString(HttpCookie httpCookie)

Formats this cookie into a string suitable to be used for logging.

Parameters:

httpCookie - the cookie to format

Returns:

a logging string representation of the cookie

formatExpires

static String formatExpires(Instant expires)

Formats the Instant associated with the Expires attribute into a RFC 1123 string.

Parameters:

expires - the expiration instant

Returns:

the instant formatted as an RFC 1123 string

See Also:

• parseExpires(String)

parseExpires

static Instant parseExpires(String expires)

Parses the Expires Date/Time attribute value into an Instant.

Parameters:

expires - a date/time in one of the RFC6265 supported formats

Returns:

an Instant parsed from the given string