Package org.openqa.selenium

Class Cookie

java.lang.Object

org.openqa.selenium.Cookie

All Implemented Interfaces:

Serializable

public class Cookie
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Cookie.Builder

Constructor Summary

Constructors

Constructor	Description
Cookie(String name, String value)	Create a cookie for the default path with the given name and value with no expiry set.
Cookie(String name, String value, String path)	Create a cookie.
Cookie(String name, String value, String domain, String path, Date expiry)	Creates an insecure non-httpOnly cookie.
Cookie(String name, String value, String domain, String path, Date expiry, boolean isSecure)	Creates a non-httpOnly cookie.
Cookie(String name, String value, String domain, String path, Date expiry, boolean isSecure, boolean isHttpOnly)	Creates a cookie.
Cookie(String name, String value, String domain, String path, Date expiry, boolean isSecure, boolean isHttpOnly, String sameSite)	Creates a cookie.
Cookie(String name, String value, String path, Date expiry)	Creates an insecure non-httpOnly cookie with no domain specified.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Two cookies are equal if the name and value match
String	getDomain()
Date	getExpiry()
String	getName()
String	getPath()
String	getSameSite()
String	getValue()
int	hashCode()
boolean	isHttpOnly()
boolean	isSecure()
Map<String,Object>	toJson()	JSON object keys are defined in https://w3c.github.io/webdriver/#dfn-table-for-cookie-conversion.
String	toString()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Details

Cookie

public Cookie(String name,
 String value,
 String path,
 Date expiry)

Creates an insecure non-httpOnly cookie with no domain specified.

Parameters:

name - The name of the cookie; may not be null or an empty string.

value - The cookie value; may not be null.

path - The path the cookie is visible to. If left blank or set to null, will be set to "/".

expiry - The cookie's expiration date; may be null.

See Also:

• Cookie(String, String, String, String, Date)

Cookie

public Cookie(String name,
 String value,
 String domain,
 String path,
 Date expiry)

Creates an insecure non-httpOnly cookie.

Parameters:

name - The name of the cookie; may not be null or an empty string.

value - The cookie value; may not be null.

domain - The domain the cookie is visible to.

path - The path the cookie is visible to. If left blank or set to null, will be set to "/".

expiry - The cookie's expiration date; may be null.

See Also:

• Cookie(String, String, String, String, Date, boolean)

Cookie

public Cookie(String name,
 String value,
 String domain,
 String path,
 Date expiry,
 boolean isSecure)

Creates a non-httpOnly cookie.

Parameters:

name - The name of the cookie; may not be null or an empty string.

value - The cookie value; may not be null.

domain - The domain the cookie is visible to.

path - The path the cookie is visible to. If left blank or set to null, will be set to "/".

expiry - The cookie's expiration date; may be null.

isSecure - Whether this cookie requires a secure connection.

Cookie

public Cookie(String name,
 String value,
 String domain,
 String path,
 Date expiry,
 boolean isSecure,
 boolean isHttpOnly)

Creates a cookie.

Parameters:

name - The name of the cookie; may not be null or an empty string.

value - The cookie value; may not be null.

domain - The domain the cookie is visible to.

path - The path the cookie is visible to. If left blank or set to null, will be set to "/".

expiry - The cookie's expiration date; may be null.

isSecure - Whether this cookie requires a secure connection.

isHttpOnly - Whether this cookie is a httpOnly cooke.

Cookie

public Cookie(String name,
 String value,
 String domain,
 String path,
 Date expiry,
 boolean isSecure,
 boolean isHttpOnly,
 String sameSite)

Creates a cookie.

Parameters:

name - The name of the cookie; may not be null or an empty string.

value - The cookie value; may not be null.

domain - The domain the cookie is visible to.

path - The path the cookie is visible to. If left blank or set to null, will be set to "/".

expiry - The cookie's expiration date; may be null.

isSecure - Whether this cookie requires a secure connection.

isHttpOnly - Whether this cookie is a httpOnly cookie.

sameSite - The samesite attribute of this cookie; e.g. None, Lax, Strict.

Cookie

public Cookie(String name,
 String value)

Create a cookie for the default path with the given name and value with no expiry set.

Parameters:

name - The cookie's name

value - The cookie's value

Cookie

public Cookie(String name,
 String value,
 String path)

Create a cookie.

Parameters:

name - The cookie's name

value - The cookie's value

path - The path the cookie is for

Method Details

getName

public String getName()

getValue

public String getValue()

getDomain

public String getDomain()

getPath

public String getPath()

isSecure

public boolean isSecure()

isHttpOnly

public boolean isHttpOnly()

getExpiry

public Date getExpiry()

getSameSite

public String getSameSite()

validate

public void validate()

toJson

public Map<String,Object> toJson()

JSON object keys are defined in https://w3c.github.io/webdriver/#dfn-table-for-cookie-conversion.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Two cookies are equal if the name and value match

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object