Java-Cookie源码

1. public class Cookie implements Cloneable {
2. private static final String LSTRING_FILE =
3. "javax.servlet.http.LocalStrings";
4. private static ResourceBundle lStrings =
5. ResourceBundle.getBundle(LSTRING_FILE);
6. //cookie本身的值
7. private String name;    // NAME= ... "$Name" style is reserved
8. private String value;   // value of NAME
9. //cookie的头部信息
10. private String comment; // ;Comment=VALUE ... describes cookie's use
11. // ;Discard ... implied by maxAge < 0
12. private String domain;  // ;Domain=VALUE ... domain that sees cookie
13. private int maxAge = -1;    // ;Max-Age=VALUE ... cookies auto-expire
14. private String path;    // ;Path=VALUE ... URLs that see the cookie
15. private boolean secure; // ;Secure ... e.g. use SSL
16. private int version = 0;    // ;Version=1 ... means RFC 2109++ style
17. /**
18. * Constructs a cookie with a specified name and value.
19. *
20. * @param name          a <code>String</code> specifying the name of the cookie
21. *
22. * @param value         a <code>String</code> specifying the value of the cookie
23. *
24. * @throws IllegalArgumentException if the cookie name contains illegal characters
25. *                  (for example, a comma, space, or semicolon)
26. *                  or it is one of the tokens reserved for use
27. *                  by the cookie protocol
28. * @see #setValue
29. * @see #setVersion
30. *
31. */
32. //构造函数，指定特定的name和value
33. public Cookie(String name, String value) {
34. if (!isToken(name)
35. || name.equalsIgnoreCase("Comment") // rfc2019
36. || name.equalsIgnoreCase("Discard") // 2019++
37. || name.equalsIgnoreCase("Domain")
38. || name.equalsIgnoreCase("Expires") // (old cookies)
39. || name.equalsIgnoreCase("Max-Age") // rfc2019
40. || name.equalsIgnoreCase("Path")
41. || name.equalsIgnoreCase("Secure")
42. || name.equalsIgnoreCase("Version")
43. || name.startsWith("$")
44. ) {
45. String errMsg = lStrings.getString("err.cookie_name_is_token");
46. Object[] errArgs = new Object[1];
47. errArgs[0] = name;
48. errMsg = MessageFormat.format(errMsg, errArgs);
49. throw new IllegalArgumentException(errMsg);
50. }
51. this.name = name;
52. this.value = value;
53. }
54. /**
55. *
56. * Specifies a comment that describes a cookie's purpose.
57. * The comment is useful if the browser presents the cookie
58. * to the user. Comments
59. * are not supported by Netscape Version 0 cookies.
60. *
61. * @param purpose       a <code>String</code> specifying the comment
62. *              to display to the user
63. *
64. * @see #getComment
65. *
66. */
67. //cookie的说明
68. public void setComment(String purpose) {
69. comment = purpose;
70. }
71. //返回cookie数目，为空返回null
72. public String getComment() {
73. return comment;
74. }
75. /**
76. * Specifies the domain within which this cookie should be presented.
77. * <p>The form of the domain name is specified by RFC 2109. A domain
78. * name begins with a dot (<code>.foo.com</code>) and means that
79. * the cookie is visible to servers in a specified Domain Name System
80. * (DNS) zone (for example, <code>www.foo.com</code>, but not
81. * <code>a.b.foo.com</code>). By default, cookies are only returned
82. * to the server that sent them.
83. * @param pattern       a <code>String</code> containing the domain name
84. *              within which this cookie is visible;
85. *              form is according to RFC 2109
86. *
87. * @see #getDomain
88. */
89. //给cookie设置在某个domain中有效
90. public void setDomain(String pattern) {
91. domain = pattern.toLowerCase(); // IE allegedly needs this
92. }
93. //获得作用域
94. public String getDomain() {
95. return domain;
96. }
97. /**
98. * Sets the maximum age of the cookie in seconds. <p>A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is
99. the <i>maximum</i> age when the cookie will expire, not the cookie's current age.
100. * <p>A negative value means
101. * that the cookie is not stored persistently and will be deleted
102. * when the Web browser exits. A zero value causes the cookie
103. * to be deleted.
104. * @param expiry        an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes
105. *  the cookie
106. * @see #getMaxAge
107. */
108. //cookie的生存时间
109. public void setMaxAge(int expiry) {
110. maxAge = expiry;
111. }
112. //获得最大生存时间
113. public int getMaxAge() {
114. return maxAge;
115. }
116. //客户端返回的cookie在某个路径
117. public void setPath(String uri) {
118. path = uri;
119. }
120. //返回客户端返回的cookie在server上的地址
121. public String getPath() {
122. return path;
123. }
124. /**
125. * Indicates to the browser whether the cookie should only be sent
126. * using a secure protocol, such as HTTPS or SSL.
127. * <p>The default value is <code>false</code>.
128. * @param flag  if <code>true</code>, sends the cookie from the browser
129. *          to the server only when using a secure protocol;
130. *          if <code>false</code>, sent on any protocol
131. * @see #getSecure
132. */
133. public void setSecure(boolean flag) {
134. secure = flag;
135. }
136. public boolean getSecure() {
137. return secure;
138. }
139. //返回cookie的name,一旦创建name不可变
140. public String getName() {
141. return name;
142. }
143. //给cookie赋值
144. public void setValue(String newValue) {
145. value = newValue;
146. }
147. //获得cookie的值
148. public String getValue() {
149. return value;
150. }
151. //返回cookie依从的协议版本
152. public int getVersion() {
153. return version;
154. }
155. //设置版本
156. public void setVersion(int v) {
157. version = v;
158. }
159. // Note -- disabled for now to allow full Netscape compatibility
160. // from RFC 2068, token special case characters
161. //
162. // private static final String tspecials = "()<>@,;:\\\"/[]?={} \t";
163. private static final String tspecials = ",; ";
164. /*
165. * Tests a string and returns true if the string counts as a
166. * reserved token in the Java language.
167. *
168. * @param value     the <code>String</code> to be tested
169. *
170. * @return          <code>true</code> if the <code>String</code> is
171. *              a reserved token; <code>false</code>
172. *              if it is not
173. */
174. private boolean isToken(String value) {
175. int len = value.length();
176. for (int i = 0; i < len; i++) {
177. char c = value.charAt(i);
178. if (c < 0x20 || c >= 0x7f || tspecials.indexOf(c) != -1)
179. return false;
180. }
181. return true;
182. }
183. //复制cookie
184. public Object clone() {
185. try {
186. return super.clone();
187. } catch (CloneNotSupportedException e) {
188. throw new RuntimeException(e.getMessage());
189. }
190. }
191. }

</pre><pre>