io.servicetalk.http.api

Class DefaultHttpSetCookie

Object

DefaultHttpSetCookie

All Implemented Interfaces:

HttpCookiePair, HttpSetCookie

public final class DefaultHttpSetCookie
extends Object
implements HttpSetCookie

Default implementation of HttpSetCookie.

Nested Class Summary

Nested classes/interfaces inherited from interface HttpSetCookie

HttpSetCookie.SameSite

Constructor Summary

Constructors

Constructor and Description
DefaultHttpSetCookie(CharSequence name, CharSequence value) Create a new not wrapped, not secure and not HTTP-only HttpSetCookie instance, with no path, domain, expire date and maximum age.
DefaultHttpSetCookie(CharSequence name, CharSequence value, boolean wrapped, boolean secure, boolean httpOnly) Create a new HttpSetCookie instance, with no path, domain, expire date and maximum age.
DefaultHttpSetCookie(CharSequence name, CharSequence value, CharSequence path, CharSequence domain, CharSequence expires, Long maxAge, HttpSetCookie.SameSite sameSite, boolean wrapped, boolean secure, boolean httpOnly) Creates a new HttpSetCookie instance.

Method Summary

Modifier and Type	Method and Description
CharSequence	domain() Returns the domain of this HttpSetCookie.
CharSequence	encoded() Get the encoded value of this HttpCookiePair.
boolean	equals(Object o)
CharSequence	expires() Returns the expire date of this HttpSetCookie according to Expires.
int	hashCode()
boolean	isHttpOnly() Checks to see if this HttpSetCookie can only be accessed via HTTP.
boolean	isSecure() Checks to see if this HttpSetCookie is secure.
boolean	isWrapped() Returns true if the value should be wrapped in DQUOTE as described in cookie-value.
Long	maxAge() Returns the maximum age of this HttpSetCookie in seconds if specified.
CharSequence	name() Returns the name of this HttpCookiePair.
static HttpSetCookie	parseSetCookie(CharSequence setCookieString, boolean validateContent) Parse a setCookie CharSequence into a HttpSetCookie.
CharSequence	path() Returns the path of this HttpSetCookie.
HttpSetCookie.SameSite	sameSite() Get the value for the SameSite attribute.
String	toString()
CharSequence	value() Returns the value of this HttpCookiePair.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultHttpSetCookie

public DefaultHttpSetCookie(CharSequence name,
                            CharSequence value)

Create a new not wrapped, not secure and not HTTP-only HttpSetCookie instance, with no path, domain, expire date and maximum age.

Parameters:

name - the cookie-name.

value - the cookie-value.

DefaultHttpSetCookie

public DefaultHttpSetCookie(CharSequence name,
                            CharSequence value,
                            boolean wrapped,
                            boolean secure,
                            boolean httpOnly)

Create a new HttpSetCookie instance, with no path, domain, expire date and maximum age.

Parameters:

name - the cookie-name.

value - the cookie-value.

wrapped - true if the value should be wrapped in DQUOTE as described in cookie-value.

secure - the secure-av.

httpOnly - the httponly-av (see HTTP-only).

DefaultHttpSetCookie

public DefaultHttpSetCookie(CharSequence name,
                            CharSequence value,
                            @Nullable
                            CharSequence path,
                            @Nullable
                            CharSequence domain,
                            @Nullable
                            CharSequence expires,
                            @Nullable
                            Long maxAge,
                            @Nullable
                            HttpSetCookie.SameSite sameSite,
                            boolean wrapped,
                            boolean secure,
                            boolean httpOnly)

Creates a new HttpSetCookie instance.

Parameters:

name - the cookie-name.

value - the cookie-value.

path - the path-value.

domain - the domain-value.

expires - the expires-av. Represented as an RFC-1123 date defined in RFC-2616, Section 3.3.1.

maxAge - the max-age-av.

wrapped - true if the value should be wrapped in DQUOTE as described in cookie-value.

secure - the secure-av.

httpOnly - the httponly-av (see HTTP-only).

sameSite - the SameSite attribute.

Method Detail

parseSetCookie

public static HttpSetCookie parseSetCookie(CharSequence setCookieString,
                                           boolean validateContent)

Parse a setCookie CharSequence into a HttpSetCookie.

Parameters:

setCookieString - The set-cookie-string value.

validateContent - true to make a best effort to validate the contents of the SetCookie.

Returns:

a HttpSetCookie representation of setCookie.

name

public CharSequence name()

Description copied from interface: HttpCookiePair

Returns the name of this HttpCookiePair.

Specified by:

name in interface HttpCookiePair

Returns:

The name of this HttpCookiePair

value

public CharSequence value()

Description copied from interface: HttpCookiePair

Returns the value of this HttpCookiePair.

Specified by:

value in interface HttpCookiePair

Returns:

The value of this HttpCookiePair

isWrapped

public boolean isWrapped()

Description copied from interface: HttpCookiePair

Returns true if the value should be wrapped in DQUOTE as described in cookie-value.

Specified by:

isWrapped in interface HttpCookiePair

Returns:

true if the value should be wrapped in DQUOTE as described in cookie-value.

domain

@Nullable
public CharSequence domain()

Description copied from interface: HttpSetCookie

Returns the domain of this HttpSetCookie.

Specified by:

domain in interface HttpSetCookie

Returns:

The domain of this HttpSetCookie

path

@Nullable
public CharSequence path()

Description copied from interface: HttpSetCookie

Returns the path of this HttpSetCookie.

Specified by:

path in interface HttpSetCookie

Returns:

The HttpSetCookie's path

maxAge

@Nullable
public Long maxAge()

Description copied from interface: HttpSetCookie

Returns the maximum age of this HttpSetCookie in seconds if specified.

Specified by:

maxAge in interface HttpSetCookie

Returns:

The maximum age of this HttpSetCookie. null if none specified.

expires

@Nullable
public CharSequence expires()

Description copied from interface: HttpSetCookie

Returns the expire date of this HttpSetCookie according to Expires.

Specified by:

expires in interface HttpSetCookie

Returns:

the expire date of this HttpSetCookie according to Expires.

sameSite

@Nullable
public HttpSetCookie.SameSite sameSite()

Description copied from interface: HttpSetCookie

Get the value for the SameSite attribute.

Specified by:

sameSite in interface HttpSetCookie

Returns:

The value for the SameSite attribute.

isSecure

public boolean isSecure()

Description copied from interface: HttpSetCookie

Checks to see if this HttpSetCookie is secure.

Specified by:

isSecure in interface HttpSetCookie

Returns:

True if this HttpSetCookie is secure, otherwise false

isHttpOnly

public boolean isHttpOnly()

Description copied from interface: HttpSetCookie

Checks to see if this HttpSetCookie can only be accessed via HTTP. If this returns true, the HttpSetCookie cannot be accessed through client side script - But only if the browser supports it. For more information, please look here

Specified by:

isHttpOnly in interface HttpSetCookie

Returns:

True if this HttpSetCookie is HTTP-only or false if it isn't

encoded

public CharSequence encoded()

Description copied from interface: HttpCookiePair

Get the encoded value of this HttpCookiePair.

Specified by:

encoded in interface HttpCookiePair

Returns:

the encoded value of this HttpCookiePair.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object