Repository navigation
Expand file tree
/
Copy pathCookie.java
More file actions
259 lines (222 loc) · 7.4 KB
/
Copy pathCookie.java
File metadata and controls
259 lines (222 loc) · 7.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you 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.io.Serializable;
import java.text.SimpleDateFormat;
import java.util.Date;
public class Cookie implements Serializable {
private static final long serialVersionUID = 4115876353625612383L;
private final String name;
private final String value;
private final String path;
private final String domain;
private final Date expiry;
private final boolean isSecure;
private final boolean isHttpOnly;
/**
* Creates an insecure non-httpOnly 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 non-httpOnly 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 non-httpOnly 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, value, domain, path, expiry, isSecure, 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.
* @param isHttpOnly Whether this cookie is a httpOnly cooke.
*/
public Cookie(String name, String value, String domain, String path, Date expiry,
boolean isSecure, boolean isHttpOnly) {
this.name = name;
this.value = value;
this.path = path == null || "".equals(path) ? "/" : path;
this.domain = stripPort(domain);
this.isSecure = isSecure;
this.isHttpOnly = isHttpOnly;
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;
}
}
/**
* 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 boolean isHttpOnly() {
return isHttpOnly;
}
public Date getExpiry() {
return expiry;
}
private static String stripPort(String domain) {
return (domain == null) ? null : domain.split(":")[0];
}
public 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;
private boolean httpOnly;
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 Builder isHttpOnly(boolean httpOnly) {
this.httpOnly = httpOnly;
return this;
}
public Cookie build() {
return new Cookie(name, value, domain, path, expiry, secure, httpOnly);
}
}
}