Class ResponseCookie

java.lang.Object

com.soklet.ResponseCookie

@ThreadSafe
public final class ResponseCookie
extends Object

HTTP "response" Cookie representation which supports Set-Cookie header encoding.

Threadsafe instances can be acquired via these builder factory methods:

• with(String, String) (builder primed with name and value)
• withName(String) (builder primed with name only)

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResponseCookie.Builder	Builder used to construct instances of ResponseCookie via withName(String) or with(String, String).
static final class	ResponseCookie.Copier	Builder used to copy instances of ResponseCookie via copy().
static enum	ResponseCookie.SameSite	Values which control whether a response cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).

Method Summary

Modifier and Type	Method	Description
ResponseCookie.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(Object object)
static Optional<ResponseCookie>	fromSetCookieHeaderRepresentation(String setCookieHeaderRepresentation)	Given a Set-Cookie header representation, provide a ResponseCookie that matches it.
Optional<String>	getDomain()	Gets the cookie's Domain value, if present.
Boolean	getHttpOnly()	Gets the cookie's HttpOnly flag, if present.
Optional<Duration>	getMaxAge()	Gets the cookie's Max-Age value expressed as a Duration, if present.
String	getName()	Gets the cookie's name.
Optional<String>	getPath()	Gets the cookie's Path value, if present.
Optional<ResponseCookie.SameSite>	getSameSite()	Gets the cookie's SameSite value, if present.
Boolean	getSecure()	Gets the cookie's Secure flag, if present.
Optional<String>	getValue()	Gets the cookie's value, if present.
int	hashCode()
String	toSetCookieHeaderRepresentation()	Generates a Set-Cookie header representation of this response cookie, for example Set-Cookie: <cookie-name>=<cookie-value>; Domain=<domain-value>; Secure; HttpOnly
String	toString()
static ResponseCookie.Builder	with(String name, String value)	Acquires a builder for ResponseCookie instances.
static ResponseCookie.Builder	withName(String name)	Acquires a builder for ResponseCookie instances without specifying the cookie's value.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

with

@Nonnull
public static ResponseCookie.Builder with(@Nonnull
 String name,
 @Nullable
 String value)

Acquires a builder for ResponseCookie instances.

Parameters:

name - the cookie name

value - the cookie value

Returns:

the builder

withName

@Nonnull
public static ResponseCookie.Builder withName(@Nonnull
 String name)

Acquires a builder for ResponseCookie instances without specifying the cookie's value.

Parameters:

name - the cookie name

Returns:

the builder

copy

@Nonnull
public ResponseCookie.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance

fromSetCookieHeaderRepresentation

@Nonnull
public static Optional<ResponseCookie> fromSetCookieHeaderRepresentation(@Nullable
 String setCookieHeaderRepresentation)

Given a Set-Cookie header representation, provide a ResponseCookie that matches it.

An example of a Set-Cookie header representation is Set-Cookie: <cookie-name>=<cookie-value>; Domain=<domain-value>; Secure; HttpOnly

Note: while the spec does not forbid multiple cookie name/value pairs to be specified in the same Set-Cookie header, this format is unusual - Soklet does not currently support parsing these kinds of cookies.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie for details.

Parameters:

setCookieHeaderRepresentation - a Set-Cookie header representation

Returns:

a ResponseCookie representation of the Set-Cookie header, or Optional.empty() if the header is null, empty, or does not include cookie data

Throws:

IllegalArgumentException - if the Set-Cookie header representation is malformed

toSetCookieHeaderRepresentation

@Nonnull
public String toSetCookieHeaderRepresentation()

Generates a Set-Cookie header representation of this response cookie, for example Set-Cookie: <cookie-name>=<cookie-value>; Domain=<domain-value>; Secure; HttpOnly

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie for details.

Returns:

this response cookie in Set-Cookie header format

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getName

@Nonnull
public String getName()

Gets the cookie's name.

Returns:

the name of the cookie

getValue

@Nonnull
public Optional<String> getValue()

Gets the cookie's value, if present.

Returns:

the value of the cookie, or Optional.empty() if there is none

getMaxAge

@Nonnull
public Optional<Duration> getMaxAge()

Gets the cookie's Max-Age value expressed as a Duration, if present.

Returns:

the Max-Age value of the cookie, or Optional.empty() if there is none

getDomain

@Nonnull
public Optional<String> getDomain()

Gets the cookie's Domain value, if present.

Returns:

the Domain value of the cookie, or Optional.empty() if there is none

getPath

@Nonnull
public Optional<String> getPath()

Gets the cookie's Path value, if present.

Returns:

the Path value of the cookie, or Optional.empty() if there is none

getSecure

@Nonnull
public Boolean getSecure()

Gets the cookie's Secure flag, if present.

Returns:

true if the Secure flag of the cookie is present, false otherwise

getHttpOnly

@Nonnull
public Boolean getHttpOnly()

Gets the cookie's HttpOnly flag, if present.

Returns:

true if the HttpOnly flag of the cookie is present, false otherwise

getSameSite

@Nonnull
public Optional<ResponseCookie.SameSite> getSameSite()

Gets the cookie's SameSite value, if present.

Returns:

the SameSite value of the cookie, or Optional.empty() if there is none