kong.unirest

Class Cookie

java.lang.Object

kong.unirest.Cookie

public class Cookie
extends Object

Represents a cookie parsed from the set-cookie header per https://tools.ietf.org/html/rfc6265 note that the RFC is awful. The wikipedia article is far easier to understand https://en.wikipedia.org/wiki/HTTP_cookie

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cookie.SameSite

Field Summary

Fields

Modifier and Type	Field and Description
static DateTimeFormatter	DEFAULT_PATTERN

Constructor Summary

Constructors

Constructor and Description
Cookie(String v) Construct a cookie from a set-cookie value
Cookie(String name, String value)

Method Summary

Modifier and Type	Method and Description
String	getDomain()
ZonedDateTime	getExpiration() Per Wikipedia: The Expires attribute defines a specific date and time for when the browser should delete the cookie.
int	getMaxAge() Per Wikipedia: the Max-Age attribute can be used to set the cookie's expiration as an interval of seconds in the future, relative to the time the browser received the cookie.
String	getName()
String	getPath()
Cookie.SameSite	getSameSite() returns the SameSite attribute
String	getUrlDecodedValue()
String	getValue()
boolean	isHttpOnly() Per Wikipedia: The HttpOnly attribute directs browsers not to expose cookies through channels other than HTTP (and HTTPS) requests.
boolean	isSecure() Per Wikipedia: The Secure attribute is meant to keep cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.
void	setDomain(String domain)
void	setHttpOnly(boolean httpOnly)
void	setPath(String path)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATTERN

public static final DateTimeFormatter DEFAULT_PATTERN

Constructor Detail

Cookie

public Cookie(String name,
              String value)

Cookie

public Cookie(String v)

Construct a cookie from a set-cookie value

Parameters:

v - cookie string value

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setDomain

public void setDomain(String domain)

setPath

public void setPath(String path)

setHttpOnly

public void setHttpOnly(boolean httpOnly)

getName

public String getName()

Returns:

the cookie-name

getValue

public String getValue()

Returns:

the cookie-value

getUrlDecodedValue

public String getUrlDecodedValue()

Returns:

the cookie-value, url-decoded

getDomain

public String getDomain()

Returns:

the domain value of the cookie

getPath

public String getPath()

Returns:

the path value of the cookie

isHttpOnly

public boolean isHttpOnly()

Per Wikipedia: The HttpOnly attribute directs browsers not to expose cookies through channels other than HTTP (and HTTPS) requests. This means that the cookie cannot be accessed via client-side scripting languages (notably JavaScript), and therefore cannot be stolen easily via cross-site scripting (a pervasive attack technique)

Returns:

a boolean if the cookie is httpOnly

isSecure

public boolean isSecure()

Per Wikipedia: The Secure attribute is meant to keep cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.

Returns:

a boolean of if the cookie is secure

getMaxAge

public int getMaxAge()

Per Wikipedia: the Max-Age attribute can be used to set the cookie's expiration as an interval of seconds in the future, relative to the time the browser received the cookie.

Returns:

Max-Age attribute

getExpiration

public ZonedDateTime getExpiration()

Per Wikipedia: The Expires attribute defines a specific date and time for when the browser should delete the cookie.

Returns:

a ZonedDateTime of the expiration

getSameSite

public Cookie.SameSite getSameSite()

returns the SameSite attribute

Returns:

the SameSite attribute if set. or null