org.openqa.selenium.Cookie Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-api Show documentation
Show all versions of selenium-api Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
/*
Copyright 2007-2009 WebDriver committers
Copyright 2007-2009 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.openqa.selenium;
import java.util.Date;
import java.text.SimpleDateFormat;
public class Cookie {
private final String name;
private final String value;
private final String path;
private final String domain;
private final Date expiry;
private final boolean isSecure;
/**
* Creates an insecure cookie with no domain specified.
*
* @param name The name of the cookie; may not be null or an empty string.
* @param value The cookie value; may not be null.
* @param path The path the cookie is visible to. If left blank or set to
* null, will be set to "/".
* @param expiry The cookie's expiration date; may be null.
* @see #Cookie(String, String, String, String, Date)
*/
public Cookie(String name, String value, String path, Date expiry) {
this(name, value, null, path, expiry);
}
/**
* Creates an insecure cookie.
*
* @param name The name of the cookie; may not be null or an empty string.
* @param value The cookie value; may not be null.
* @param domain The domain the cookie is visible to.
* @param path The path the cookie is visible to. If left blank or set to
* null, will be set to "/".
* @param expiry The cookie's expiration date; may be null.
* @see #Cookie(String, String, String, String, Date, boolean)
*/
public Cookie(String name, String value, String domain, String path, Date expiry) {
this(name, value, domain, path, expiry, false);
}
/**
* Creates a cookie.
*
* @param name The name of the cookie; may not be null or an empty string.
* @param value The cookie value; may not be null.
* @param domain The domain the cookie is visible to.
* @param path The path the cookie is visible to. If left blank or set to
* null, will be set to "/".
* @param expiry The cookie's expiration date; may be null.
* @param isSecure Whether this cookie requires a secure connection.
*/
public Cookie(String name, String value, String domain, String path, Date expiry,
boolean isSecure) {
this.name = name;
this.value = value;
this.path = path == null || "".equals(path) ? "/" : path;
this.domain = stripPort(domain);
this.isSecure = isSecure;
if (expiry != null) {
// Expiration date is specified in seconds since (UTC) epoch time, so truncate the date.
this.expiry = new Date(expiry.getTime() / 1000 * 1000);
} else {
this.expiry = null;
}
validate();
}
/**
* Create a cookie for the default path with the given name and value with
* no expiry set.
*
* @param name The cookie's name
* @param value The cookie's value
*/
public Cookie(String name, String value) {
this(name, value, "/", null);
}
/**
* Create a cookie.
*
* @param name The cookie's name
* @param value The cookie's value
* @param path The path the cookie is for
*/
public Cookie(String name, String value, String path) {
this(name, value, path, null);
}
public String getName() {
return name;
}
public String getValue() {
return value;
}
public String getDomain() {
return domain;
}
public String getPath() {
return path;
}
public boolean isSecure() {
return isSecure;
}
public Date getExpiry() {
return expiry;
}
private static String stripPort(String domain) {
return (domain == null) ? null : domain.split(":")[0];
}
protected void validate() {
if (name == null || "".equals(name) || value == null || path == null) {
throw new IllegalArgumentException("Required attributes are not set or " +
"any non-null attribute set to null");
}
if (name.indexOf(';') != -1) {
throw new IllegalArgumentException(
"Cookie names cannot contain a ';': " + name);
}
if (domain != null && domain.contains(":")) {
throw new IllegalArgumentException("Domain should not contain a port: " + domain);
}
}
@Override
public String toString() {
return name + "=" + value
+ (expiry == null ? ""
: "; expires=" + new SimpleDateFormat("EEE, dd MMM yyyy hh:mm:ss z")
.format(expiry))
+ ("".equals(path) ? "" : "; path=" + path)
+ (domain == null ? "" : "; domain=" + domain)
+ (isSecure ? ";secure;" : "");
}
/**
* Two cookies are equal if the name and value match
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Cookie)) {
return false;
}
Cookie cookie = (Cookie) o;
if (!name.equals(cookie.name)) {
return false;
}
return !(value != null ? !value.equals(cookie.value) : cookie.value != null);
}
@Override
public int hashCode() {
return name.hashCode();
}
public static class Builder {
private final String name;
private final String value;
private String path;
private String domain;
private Date expiry;
private boolean secure;
public Builder(String name, String value) {
this.name = name;
this.value = value;
}
public Builder domain(String host) {
this.domain = stripPort(host);
return this;
}
public Builder path(String path) {
this.path = path;
return this;
}
public Builder expiresOn(Date expiry) {
this.expiry = expiry;
return this;
}
public Builder isSecure(boolean secure) {
this.secure = secure;
return this;
}
public Cookie build() {
return new Cookie(name, value, domain, path, expiry, secure);
}
}
}