jdk-sandbox: comparison jdk/src/share/classes/java/net/HttpCookie.java

equal deleted inserted replaced

-:4ee27839f531
+:4dcb5baa61f3
 import java.util.StringTokenizer;
 import java.util.NoSuchElementException;
 import java.text.SimpleDateFormat;
 import java.util.TimeZone;
 import java.util.Date;
-import java.lang.NullPointerException;  // for javadoc
 import java.util.Locale;
 import java.util.Objects;
 /**
-* An HttpCookie object represents an http cookie, which carries state
+* An HttpCookie object represents an HTTP cookie, which carries state
 * information between server and user agent. Cookie is widely adopted
 * to create stateful sessions.
 *
-* <p>There are 3 http cookie specifications:
+* <p> There are 3 HTTP cookie specifications:
 * <blockquote>
 *   Netscape draft<br>
 *   RFC 2109 - <a href="http://www.ietf.org/rfc/rfc2109.txt">
 * <i>http://www.ietf.org/rfc/rfc2109.txt</i></a><br>
 *   RFC 2965 - <a href="http://www.ietf.org/rfc/rfc2965.txt">
 * <i>http://www.ietf.org/rfc/rfc2965.txt</i></a>
 * </blockquote>
 *
-* <p>HttpCookie class can accept all these 3 forms of syntax.
+* <p> HttpCookie class can accept all these 3 forms of syntax.
 *
 * @author Edward Wang
 * @since 1.6
 */
 public final class HttpCookie implements Cloneable {
-/* ---------------- Fields -------------- */
+// ---------------- Fields --------------
-//
 // The value of the cookie itself.
-//
+private final String name;  // NAME= ... "$Name" style is reserved
-private String name;        // NAME= ... "$Name" style is reserved
 private String value;       // value of NAME
-//
 // Attributes encoded in the header's cookie fields.
-//
 private String comment;     // Comment=VALUE ... describes cookie's use
 private String commentURL;  // CommentURL="http URL" ... describes cookie's use
 private boolean toDiscard;  // Discard ... discard cookie unconditionally
 private String domain;      // Domain=VALUE ... domain that sees cookie
 private long maxAge = MAX_AGE_UNSPECIFIED;  // Max-Age=VALUE ... cookies auto-expire
 private String portlist;    // Port[="portlist"] ... the port cookie may be returned to
 private boolean secure;     // Secure ... e.g. use SSL
 private boolean httpOnly;   // HttpOnly ... i.e. not accessible to scripts
 private int version = 1;    // Version=1 ... RFC 2965 style
-//
 // Hold the creation time (in seconds) of the http cookie for later
 // expiration calculation
-//
+private final long whenCreated;
-private long whenCreated = 0;
-//
 // Since the positive and zero max-age have their meanings,
 // this value serves as a hint as 'not specify max-age'
-//
 private final static long MAX_AGE_UNSPECIFIED = -1;
-//
 // date formats used by Netscape's cookie draft
 // as well as formats seen on various sites
-//
 private final static String[] COOKIE_DATE_FORMATS = {
 "EEE',' dd-MMM-yyyy HH:mm:ss 'GMT'",
 "EEE',' dd MMM yyyy HH:mm:ss 'GMT'",
 "EEE MMM dd yyyy HH:mm:ss 'GMT'Z"
 };
-//
 // constant strings represent set-cookie header token
-//
 private final static String SET_COOKIE = "set-cookie:";
 private final static String SET_COOKIE2 = "set-cookie2:";
+// ---------------- Ctors --------------
-/* ---------------- Ctors -------------- */
 /**
 * Constructs a cookie with a specified name and value.
 *
-* <p>The name must conform to RFC 2965. That means it can contain
+* <p> The name must conform to RFC 2965. That means it can contain
 * only ASCII alphanumeric characters and cannot contain commas,
 * semicolons, or white space or begin with a $ character. The cookie's
 * name cannot be changed after creation.
 *
-* <p>The value can be anything the server chooses to send. Its
+* <p> The value can be anything the server chooses to send. Its
 * value is probably of interest only to the server. The cookie's
 * value can be changed after creation with the
-* <code>setValue</code> method.
+* {@code setValue} method.
 *
-* <p>By default, cookies are created according to the RFC 2965
+* <p> By default, cookies are created according to the RFC 2965
 * cookie specification. The version can be changed with the
-* <code>setVersion</code> method.
+* {@code setVersion} method.
 *
 *
-* @param name                      a <code>String</code> specifying the name of the cookie
+* @param  name
-*
+*         a {@code String} specifying the name of the cookie
-* @param value                     a <code>String</code> specifying the value of the cookie
+*
-*
+* @param  value
-* @throws IllegalArgumentException if the cookie name contains illegal characters
+*         a {@code String} specifying the value of the cookie
-*                                  or it is one of the tokens reserved for use
+*
-*                                  by the cookie protocol
+* @throws  IllegalArgumentException
-* @throws NullPointerException     if <tt>name</tt> is <tt>null</tt>
+*          if the cookie name contains illegal characters or it is one of
+*          the tokens reserved for use by the cookie protocol
+* @throws  NullPointerException
+*          if {@code name} is {@code null}
+*
 * @see #setValue
 * @see #setVersion
-*
+*/
-*/
 public HttpCookie(String name, String value) {
 name = name.trim();
 if (name.length() == 0 || !isToken(name) || isReserved(name)) {
 throw new IllegalArgumentException("Illegal cookie name");
 }
 whenCreated = System.currentTimeMillis();
 portlist = null;
 }
 /**
 * Constructs cookies from set-cookie or set-cookie2 header string.
 * RFC 2965 section 3.2.2 set-cookie2 syntax indicates that one header line
 * may contain more than one cookie definitions, so this is a static
 * utility method instead of another constructor.
 *
-* @param header    a <tt>String</tt> specifying the set-cookie header.
+* @param  header
-*                  The header should start with "set-cookie", or "set-cookie2"
+*         a {@code String} specifying the set-cookie header. The header
-*                  token; or it should have no leading token at all.
+*         should start with "set-cookie", or "set-cookie2" token; or it
-* @return          a List of cookie parsed from header line string
+*         should have no leading token at all.
-* @throws IllegalArgumentException if header string violates the cookie
+*
-*                                  specification's syntax, or the cookie
+* @return  a List of cookie parsed from header line string
-*                                  name contains llegal characters, or
+*
-*                                  the cookie name is one of the tokens
+* @throws  IllegalArgumentException
-*                                  reserved for use by the cookie protocol
+*          if header string violates the cookie specification's syntax, or
-* @throws NullPointerException     if the header string is <tt>null</tt>
+*          the cookie name contains illegal characters, or the cookie name
+*          is one of the tokens reserved for use by the cookie protocol
+* @throws  NullPointerException
+*          if the header string is {@code null}
 */
 public static List<HttpCookie> parse(String header) {
 int version = guessCookieVersion(header);
 // if header start with set-cookie or set-cookie2, strip it off
 header = header.substring(SET_COOKIE2.length());
 } else if (startsWithIgnoreCase(header, SET_COOKIE)) {
 header = header.substring(SET_COOKIE.length());
 }
+List<HttpCookie> cookies = new java.util.ArrayList<>();
-List<HttpCookie> cookies = new java.util.ArrayList<HttpCookie>();
+// The Netscape cookie may have a comma in its expires attribute, while
-// The Netscape cookie may have a comma in its expires attribute,
+// the comma is the delimiter in rfc 2965/2109 cookie header string.
-// while the comma is the delimiter in rfc 2965/2109 cookie header string.
 // so the parse logic is slightly different
 if (version == 0) {
 // Netscape draft cookie
 HttpCookie cookie = parseInternal(header);
 cookie.setVersion(0);
 }
 return cookies;
 }
+// ---------------- Public operations --------------
+/**
-/* ---------------- Public operations -------------- */
+* Reports whether this HTTP cookie has expired or not.
+*
+* @return  {@code true} to indicate this HTTP cookie has expired;
-/**
+*          otherwise, {@code false}
-* Reports whether this http cookie has expired or not.
-*
-* @return  <tt>true</tt> to indicate this http cookie has expired;
-*          otherwise, <tt>false</tt>
 */
 public boolean hasExpired() {
 if (maxAge == 0) return true;
 // if not specify max-age, this cookie should be
 else
 return false;
 }
 /**
-*
 * Specifies a comment that describes a cookie's purpose.
 * The comment is useful if the browser presents the cookie
-* to the user. Comments
+* to the user. Comments are not supported by Netscape Version 0 cookies.
-* are not supported by Netscape Version 0 cookies.
+*
-*
+* @param  purpose
-* @param purpose           a <code>String</code> specifying the comment
+*         a {@code String} specifying the comment to display to the user
-*                          to display to the user
+*
-*
+* @see  #getComment
-* @see #getComment
+*/
-*
-*/
 public void setComment(String purpose) {
 comment = purpose;
 }
 /**
 * Returns the comment describing the purpose of this cookie, or
-* <code>null</code> if the cookie has no comment.
+* {@code null} if the cookie has no comment.
 *
-* @return                  a <code>String</code> containing the comment,
+* @return  a {@code String} containing the comment, or {@code null} if none
-*                          or <code>null</code> if none
+*
-*
+* @see  #setComment
-* @see #setComment
+*/
-*
-*/
 public String getComment() {
 return comment;
 }
+/**
-/**
+* Specifies a comment URL that describes a cookie's purpose.
-*
+* The comment URL is useful if the browser presents the cookie
-* Specifies a comment url that describes a cookie's purpose.
+* to the user. Comment URL is RFC 2965 only.
-* The comment url is useful if the browser presents the cookie
+*
-* to the user. Comment url is RFC 2965 only.
+* @param  purpose
-*
+*         a {@code String} specifying the comment URL to display to the user
-* @param purpose           a <code>String</code> specifying the comment url
+*
-*                          to display to the user
+* @see  #getCommentURL
-*
+*/
-* @see #getCommentURL
-*
-*/
 public void setCommentURL(String purpose) {
 commentURL = purpose;
 }
+/**
+* Returns the comment URL describing the purpose of this cookie, or
+* {@code null} if the cookie has no comment URL.
-/**
+*
-* Returns the comment url describing the purpose of this cookie, or
+* @return  a {@code String} containing the comment URL, or {@code null}
-* <code>null</code> if the cookie has no comment url.
+*          if none
 *
-* @return                  a <code>String</code> containing the comment url,
+* @see  #setCommentURL
-*                          or <code>null</code> if none
+*/
-*
-* @see #setCommentURL
-*
-*/
 public String getCommentURL() {
 return commentURL;
 }
 /**
 * Specify whether user agent should discard the cookie unconditionally.
 * This is RFC 2965 only attribute.
 *
-* @param discard   <tt>true</tt> indicates to discard cookie unconditionally
+* @param  discard
-*
+*         {@code true} indicates to discard cookie unconditionally
-* @see #getDiscard
+*
-*/
+* @see  #getDiscard
+*/
 public void setDiscard(boolean discard) {
 toDiscard = discard;
 }
+/**
+* Returns the discard attribute of the cookie
+*
-/**
+* @return  a {@code boolean} to represent this cookie's discard attribute
-* Return the discard attribute of the cookie
+*
-*
+* @see  #setDiscard
-* @return  a <tt>boolean</tt> to represent this cookie's discard attribute
+*/
-*
-* @see #setDiscard
-*/
 public boolean getDiscard() {
 return toDiscard;
 }
 /**
 * Specify the portlist of the cookie, which restricts the port(s)
 * to which a cookie may be sent back in a Cookie header.
 *
-* @param ports     a <tt>String</tt> specify the port list, which is
+* @param  ports
-*                  comma seperated series of digits
+*         a {@code String} specify the port list, which is comma separated
-* @see #getPortlist
+*         series of digits
-*/
+*
+* @see  #getPortlist
+*/
 public void setPortlist(String ports) {
 portlist = ports;
 }
+/**
+* Returns the port list attribute of the cookie
+*
-/**
+* @return  a {@code String} contains the port list or {@code null} if none
-* Return the port list attribute of the cookie
+*
-*
+* @see  #setPortlist
-* @return  a <tt>String</tt> contains the port list
+*/
-*          or <tt>null</tt> if none
-* @see #setPortlist
-*/
 public String getPortlist() {
 return portlist;
 }
 /**
-*
 * Specifies the domain within which this cookie should be presented.
 *
-* <p>The form of the domain name is specified by RFC 2965. A domain
+* <p> The form of the domain name is specified by RFC 2965. A domain
-* name begins with a dot (<code>.foo.com</code>) and means that
+* name begins with a dot ({@code .foo.com}) and means that
 * the cookie is visible to servers in a specified Domain Name System
-* (DNS) zone (for example, <code>www.foo.com</code>, but not
+* (DNS) zone (for example, {@code www.foo.com}, but not
-* <code>a.b.foo.com</code>). By default, cookies are only returned
+* {@code a.b.foo.com}). By default, cookies are only returned
 * to the server that sent them.
 *
-*
+* @param  pattern
-* @param pattern           a <code>String</code> containing the domain name
+*         a {@code String} containing the domain name within which this
-*                          within which this cookie is visible;
+*         cookie is visible; form is according to RFC 2965
-*                          form is according to RFC 2965
+*
-*
+* @see  #getDomain
-* @see #getDomain
+*/
-*
-*/
 public void setDomain(String pattern) {
 if (pattern != null)
 domain = pattern.toLowerCase();
 else
 domain = pattern;
 }
+/**
+* Returns the domain name set for this cookie. The form of the domain name
+* is set by RFC 2965.
+*
-/**
+* @return  a {@code String} containing the domain name
-* Returns the domain name set for this cookie. The form of
+*
-* the domain name is set by RFC 2965.
+* @see  #setDomain
-*
+*/
-* @return                  a <code>String</code> containing the domain name
-*
-* @see #setDomain
-*
-*/
 public String getDomain() {
 return domain;
 }
 /**
 * Sets the maximum age of the cookie in seconds.
 *
-* <p>A positive value indicates that the cookie will expire
+* <p> A positive value indicates that the cookie will expire
 * after that many seconds have passed. Note that the value is
 * the <i>maximum</i> age when the cookie will expire, not the cookie's
 * current age.
 *
-* <p>A negative value means
+* <p> A negative value means that the cookie is not stored persistently
-* that the cookie is not stored persistently and will be deleted
+* and will be deleted when the Web browser exits. A zero value causes the
-* when the Web browser exits. A zero value causes the cookie
+* cookie to be deleted.
-* to be deleted.
+*
-*
+* @param  expiry
-* @param expiry            an integer specifying the maximum age of the
+*         an integer specifying the maximum age of the cookie in seconds;
-*                          cookie in seconds; if zero, the cookie
+*         if zero, the cookie should be discarded immediately; otherwise,
-*                          should be discarded immediately;
+*         the cookie's max age is unspecified.
-*                          otherwise, the cookie's max age is unspecified.
+*
-*
+* @see  #getMaxAge
-* @see #getMaxAge
-*
 */
 public void setMaxAge(long expiry) {
 maxAge = expiry;
 }
+/**
+* Returns the maximum age of the cookie, specified in seconds. By default,
+* {@code -1} indicating the cookie will persist until browser shutdown.
-/**
+*
-* Returns the maximum age of the cookie, specified in seconds.
+* @return  an integer specifying the maximum age of the cookie in seconds
-* By default, <code>-1</code> indicating the cookie will persist
+*
-* until browser shutdown.
+* @see  #setMaxAge
-*
+*/
-*
-* @return                  an integer specifying the maximum age of the
-*                          cookie in seconds
-*
-*
-* @see #setMaxAge
-*
-*/
 public long getMaxAge() {
 return maxAge;
 }
+/**
+* Specifies a path for the cookie to which the client should return
+* the cookie.
-/**
+*
-* Specifies a path for the cookie
+* <p> The cookie is visible to all the pages in the directory
-* to which the client should return the cookie.
-*
-* <p>The cookie is visible to all the pages in the directory
 * you specify, and all the pages in that directory's subdirectories.
 * A cookie's path must include the servlet that set the cookie,
 * for example, <i>/catalog</i>, which makes the cookie
 * visible to all directories on the server under <i>/catalog</i>.
 *
-* <p>Consult RFC 2965 (available on the Internet) for more
+* <p> Consult RFC 2965 (available on the Internet) for more
 * information on setting path names for cookies.
 *
-*
+* @param  uri
-* @param uri               a <code>String</code> specifying a path
+*         a {@code String} specifying a path
 *
-*
+* @see  #getPath
-* @see #getPath
+*/
-*
-*/
 public void setPath(String uri) {
 path = uri;
 }
+/**
+* Returns the path on the server to which the browser returns this cookie.
+* The cookie is visible to all subpaths on the server.
-/**
+*
-* Returns the path on the server
+* @return  a {@code String} specifying a path that contains a servlet name,
-* to which the browser returns this cookie. The
+*          for example, <i>/catalog</i>
-* cookie is visible to all subpaths on the server.
+*
-*
+* @see  #setPath
-*
+*/
-* @return          a <code>String</code> specifying a path that contains
-*                  a servlet name, for example, <i>/catalog</i>
-*
-* @see #setPath
-*
-*/
 public String getPath() {
 return path;
 }
 /**
 * Indicates whether the cookie should only be sent using a secure protocol,
 * such as HTTPS or SSL.
 *
-* <p>The default value is <code>false</code>.
+* <p> The default value is {@code false}.
 *
-* @param flag      If <code>true</code>, the cookie can only be sent over
+* @param  flag
-*                  a secure protocol like https.
+*         If {@code true}, the cookie can only be sent over a secure
-*                  If <code>false</code>, it can be sent over any protocol.
+*         protocol like HTTPS. If {@code false}, it can be sent over
-*
+*         any protocol.
-* @see #getSecure
+*
-*
+* @see  #getSecure
 */
 public void setSecure(boolean flag) {
 secure = flag;
 }
+/**
+* Returns {@code true} if sending this cookie should be restricted to a
+* secure protocol, or {@code false} if the it can be sent using any
-/**
+* protocol.
-* Returns <code>true</code> if sending this cookie should be
+*
-* restricted to a secure protocol, or <code>false</code> if the
+* @return  {@code false} if the cookie can be sent over any standard
-* it can be sent using any protocol.
+*          protocol; otherwise, <code>true</code>
 *
-* @return          <code>false</code> if the cookie can be sent over
+* @see  #setSecure
-*                  any standard protocol; otherwise, <code>true</code>
+*/
-*
-* @see #setSecure
-*
-*/
 public boolean getSecure() {
 return secure;
 }
 /**
 * Returns the name of the cookie. The name cannot be changed after
 * creation.
 *
-* @return          a <code>String</code> specifying the cookie's name
+* @return  a {@code String} specifying the cookie's name
-*
+*/
-*/
 public String getName() {
 return name;
 }
+/**
-/**
-*
 * Assigns a new value to a cookie after the cookie is created.
 * If you use a binary value, you may want to use BASE64 encoding.
 *
-* <p>With Version 0 cookies, values should not contain white
+* <p> With Version 0 cookies, values should not contain white space,
-* space, brackets, parentheses, equals signs, commas,
+* brackets, parentheses, equals signs, commas, double quotes, slashes,
-* double quotes, slashes, question marks, at signs, colons,
+* question marks, at signs, colons, and semicolons. Empty values may not
-* and semicolons. Empty values may not behave the same way
+* behave the same way on all browsers.
-* on all browsers.
+*
-*
+* @param  newValue
-* @param newValue          a <code>String</code> specifying the new value
+*         a {@code String} specifying the new value
 *
-*
+* @see  #getValue
-* @see #getValue
+*/
-*
-*/
 public void setValue(String newValue) {
 value = newValue;
 }
 /**
 * Returns the value of the cookie.
 *
-* @return                  a <code>String</code> containing the cookie's
+* @return  a {@code String} containing the cookie's present value
-*                          present value
+*
-*
+* @see  #setValue
-* @see #setValue
+*/
-*
-*/
 public String getValue() {
 return value;
 }
+/**
+* Returns the version of the protocol this cookie complies with. Version 1
+* complies with RFC 2965/2109, and version 0 complies with the original
-/**
+* cookie specification drafted by Netscape. Cookies provided by a browser
-* Returns the version of the protocol this cookie complies
+* use and identify the browser's cookie version.
-* with. Version 1 complies with RFC 2965/2109,
+*
-* and version 0 complies with the original
+* @return  0 if the cookie complies with the original Netscape
-* cookie specification drafted by Netscape. Cookies provided
+*          specification; 1 if the cookie complies with RFC 2965/2109
-* by a browser use and identify the browser's cookie version.
+*
-*
+* @see  #setVersion
-*
+*/
-* @return                  0 if the cookie complies with the
-*                          original Netscape specification; 1
-*                          if the cookie complies with RFC 2965/2109
-*
-* @see #setVersion
-*
-*/
 public int getVersion() {
 return version;
 }
 /**
 * Sets the version of the cookie protocol this cookie complies
 * with. Version 0 complies with the original Netscape cookie
 * specification. Version 1 complies with RFC 2965/2109.
 *
-*
+* @param  v
-* @param v                 0 if the cookie should comply with
+*         0 if the cookie should comply with the original Netscape
-*                          the original Netscape specification;
+*         specification; 1 if the cookie should comply with RFC 2965/2109
-*                          1 if the cookie should comply with RFC 2965/2109
+*
-*
+* @throws  IllegalArgumentException
-* @throws IllegalArgumentException if <tt>v</tt> is neither 0 nor 1
+*          if {@code v} is neither 0 nor 1
 *
-* @see #getVersion
+* @see  #getVersion
-*
+*/
-*/
 public void setVersion(int v) {
 if (v != 0 && v != 1) {
 throw new IllegalArgumentException("cookie version should be 0 or 1");
 }
 /**
 * Returns {@code true} if this cookie contains the <i>HttpOnly</i>
 * attribute. This means that the cookie should not be accessible to
 * scripting engines, like javascript.
 *
-* @return {@code true} if this cookie should be considered http only.
+* @return  {@code true} if this cookie should be considered HTTPOnly
-* @see #setHttpOnly(boolean)
+*
-*/
+* @see  #setHttpOnly(boolean)
-public boolean isHttpOnly()
+*/
-{
+public boolean isHttpOnly() {
 return httpOnly;
 }
 /**
 * Indicates whether the cookie should be considered HTTP Only. If set to
 * {@code true} it means the cookie should not be accessible to scripting
 * engines like javascript.
 *
-* @param httpOnly if {@code true} make the cookie HTTP only, i.e.
+* @param  httpOnly
-*                 only visible as part of an HTTP request.
+*         if {@code true} make the cookie HTTP only, i.e. only visible as
-* @see #isHttpOnly()
+*         part of an HTTP request.
-*/
+*
-public void setHttpOnly(boolean httpOnly)
+* @see  #isHttpOnly()
-{
+*/
+public void setHttpOnly(boolean httpOnly) {
 this.httpOnly = httpOnly;
 }
 /**
-* The utility method to check whether a host name is in a domain
+* The utility method to check whether a host name is in a domain or not.
-* or not.
+*
-*
+* <p> This concept is described in the cookie specification.
-* <p>This concept is described in the cookie specification.
 * To understand the concept, some terminologies need to be defined first:
 * <blockquote>
 * effective host name = hostname if host name contains dot<br>
-* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or = hostname.local if not
+* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or = hostname.local if not
 * </blockquote>
 * <p>Host A's name domain-matches host B's if:
 * <blockquote><ul>
 *   <li>their host name strings string-compare equal; or</li>
 *   <li>A is a HDN string and has the form NB, where N is a non-empty
 *   <li>A Set-Cookie2 from request-host example for Domain=.local will
 *   be accepted, because the effective host name for the request-
 *   host is example.local, and example.local domain-matches .local.</li>
 * </ul></blockquote>
 *
-* @param domain    the domain name to check host name with
+* @param  domain
-* @param host      the host name in question
+*         the domain name to check host name with
-* @return          <tt>true</tt> if they domain-matches; <tt>false</tt> if not
+*
+* @param  host
+*         the host name in question
+*
+* @return  {@code true} if they domain-matches; {@code false} if not
 */
 public static boolean domainMatches(String domain, String host) {
 if (domain == null || host == null)
 return false;
 boolean isLocalDomain = ".local".equalsIgnoreCase(domain);
 int embeddedDotInDomain = domain.indexOf('.');
 if (embeddedDotInDomain == 0)
 embeddedDotInDomain = domain.indexOf('.', 1);
 if (!isLocalDomain
-&& (embeddedDotInDomain == -1 || embeddedDotInDomain == domain.length() - 1))
+&& (embeddedDotInDomain == -1 ||
+embeddedDotInDomain == domain.length() - 1))
 return false;
 // if the host name contains no dot and the domain name
 // is .local or host.local
 int firstDotInHost = host.indexOf('.');
 }
 return false;
 }
 /**
 * Constructs a cookie header string representation of this cookie,
 * which is in the format defined by corresponding cookie specification,
 * but without the leading "Cookie:" token.
 *
 } else {
 return toNetscapeHeaderString();
 }
 }
+/**
-/**
+* Test the equality of two HTTP cookies.
-* Test the equality of two http cookies.
+*
-*
+* <p> The result is {@code true} only if two cookies come from same domain
-* <p> The result is <tt>true</tt> only if two cookies
+* (case-insensitive), have same name (case-insensitive), and have same path
-* come from same domain (case-insensitive),
+* (case-sensitive).
-* have same name (case-insensitive),
+*
-* and have same path (case-sensitive).
+* @return  {@code true} if two HTTP cookies equal to each other;
-*
+*          otherwise, {@code false}
-* @return          <tt>true</tt> if 2 http cookies equal to each other;
-*                  otherwise, <tt>false</tt>
 */
 @Override
 public boolean equals(Object obj) {
 if (obj == this)
 return true;
 return equalsIgnoreCase(getName(), other.getName()) &&
 equalsIgnoreCase(getDomain(), other.getDomain()) &&
 Objects.equals(getPath(), other.getPath());
 }
+/**
-/**
+* Returns the hash code of this HTTP cookie. The result is the sum of
-* Return hash code of this http cookie. The result is the sum of
+* hash code value of three significant components of this cookie: name,
-* hash code value of three significant components of this cookie:
+* domain, and path. That is, the hash code is the value of the expression:
-* name, domain, and path.
-* That is, the hash code is the value of the expression:
 * <blockquote>
 * getName().toLowerCase().hashCode()<br>
 * + getDomain().toLowerCase().hashCode()<br>
 * + getPath().hashCode()
 * </blockquote>
 *
-* @return          this http cookie's hash code
+* @return  this HTTP cookie's hash code
 */
 @Override
 public int hashCode() {
 int h1 = name.toLowerCase().hashCode();
 int h2 = (domain!=null) ? domain.toLowerCase().hashCode() : 0;
 }
 /**
 * Create and return a copy of this object.
 *
-* @return          a clone of this http cookie
+* @return  a clone of this HTTP cookie
 */
 @Override
 public Object clone() {
 try {
 return super.clone();
 } catch (CloneNotSupportedException e) {
 throw new RuntimeException(e.getMessage());
 }
 }
+// ---------------- Private operations --------------
-/* ---------------- Private operations -------------- */
 // Note -- disabled for now to allow full Netscape compatibility
 // from RFC 2068, token special case characters
 //
 // private static final String tspecials = "()<>@,;:\\\"/[]?={} \t";
 private static final String tspecials = ",;";
 /*
-* Tests a string and returns true if the string counts as a
+* Tests a string and returns true if the string counts as a token.
-* token.
+*
-*
+* @param  value
-* @param value             the <code>String</code> to be tested
+*         the {@code String} to be tested
 *
-* @return                  <code>true</code> if the <code>String</code> is
+* @return  {@code true} if the {@code String} is a token;
-*                          a token; <code>false</code> if it is not
+*          {@code false} if it is not
 */
 private static boolean isToken(String value) {
 int len = value.length();
 for (int i = 0; i < len; i++) {
 char c = value.charAt(i);
 return false;
 }
 return true;
 }
 /*
-* @param name      the name to be tested
+* @param  name
-* @return          <tt>true</tt> if the name is reserved by cookie
+*         the name to be tested
-*                  specification, <tt>false</tt> if it is not
+*
+* @return  {@code true} if the name is reserved by cookie specification,
+*          {@code false} if it is not
 */
 private static boolean isReserved(String name) {
 if (name.equalsIgnoreCase("Comment")
 || name.equalsIgnoreCase("CommentURL")      // rfc2965 only
 || name.equalsIgnoreCase("Discard")         // rfc2965 only
 }
 return false;
 }
 /*
 * Parse header string to cookie object.
 *
-* @param header    header string; should contain only one NAME=VALUE pair
+* @param  header
-*
+*         header string; should contain only one NAME=VALUE pair
-* @return          an HttpCookie being extracted
+*
-*
+* @return  an HttpCookie being extracted
-* @throws IllegalArgumentException if header string violates the cookie
+*
-*                                  specification
+* @throws  IllegalArgumentException
+*          if header string violates the cookie specification
 */
 private static HttpCookie parseInternal(String header)
 {
 HttpCookie cookie = null;
 String namevaluePair = null;
 }
 return cookie;
 }
 /*
 * assign cookie attribute value to attribute name;
 * use a map to simulate method dispatch
 */
 static interface CookieAttributeAssignor {
-public void assign(HttpCookie cookie, String attrName, String attrValue);
+public void assign(HttpCookie cookie,
-}
+String attrName,
-static java.util.Map<String, CookieAttributeAssignor> assignors = null;
+String attrValue);
+}
+static final java.util.Map<String, CookieAttributeAssignor> assignors =
+new java.util.HashMap<>();
 static {
-assignors = new java.util.HashMap<String, CookieAttributeAssignor>();
+assignors.put("comment", new CookieAttributeAssignor() {
-assignors.put("comment", new CookieAttributeAssignor(){
+public void assign(HttpCookie cookie,
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+String attrName,
-if (cookie.getComment() == null) cookie.setComment(attrValue);
+String attrValue) {
+if (cookie.getComment() == null)
+cookie.setComment(attrValue);
 }
 });
-assignors.put("commenturl", new CookieAttributeAssignor(){
+assignors.put("commenturl", new CookieAttributeAssignor() {
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
-if (cookie.getCommentURL() == null) cookie.setCommentURL(attrValue);
+String attrName,
+String attrValue) {
+if (cookie.getCommentURL() == null)
+cookie.setCommentURL(attrValue);
 }
 });
-assignors.put("discard", new CookieAttributeAssignor(){
+assignors.put("discard", new CookieAttributeAssignor() {
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 cookie.setDiscard(true);
 }
 });
 assignors.put("domain", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
-if (cookie.getDomain() == null) cookie.setDomain(attrValue);
+String attrName,
+String attrValue) {
+if (cookie.getDomain() == null)
+cookie.setDomain(attrValue);
 }
 });
 assignors.put("max-age", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 try {
 long maxage = Long.parseLong(attrValue);
-if (cookie.getMaxAge() == MAX_AGE_UNSPECIFIED) cookie.setMaxAge(maxage);
+if (cookie.getMaxAge() == MAX_AGE_UNSPECIFIED)
+cookie.setMaxAge(maxage);
 } catch (NumberFormatException ignored) {
-throw new IllegalArgumentException("Illegal cookie max-age attribute");
+throw new IllegalArgumentException(
+"Illegal cookie max-age attribute");
 }
 }
 });
 assignors.put("path", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
-if (cookie.getPath() == null) cookie.setPath(attrValue);
+String attrName,
+String attrValue) {
+if (cookie.getPath() == null)
+cookie.setPath(attrValue);
 }
 });
 assignors.put("port", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
-if (cookie.getPortlist() == null) cookie.setPortlist(attrValue == null ? "" : attrValue);
+String attrName,
+String attrValue) {
+if (cookie.getPortlist() == null)
+cookie.setPortlist(attrValue == null ? "" : attrValue);
 }
 });
 assignors.put("secure", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 cookie.setSecure(true);
 }
 });
 assignors.put("httponly", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 cookie.setHttpOnly(true);
 }
 });
 assignors.put("version", new CookieAttributeAssignor(){
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 try {
 int version = Integer.parseInt(attrValue);
 cookie.setVersion(version);
 } catch (NumberFormatException ignored) {
 // Just ignore bogus version, it will default to 0 or 1
 }
 }
 });
 assignors.put("expires", new CookieAttributeAssignor(){ // Netscape only
-public void assign(HttpCookie cookie, String attrName, String attrValue) {
+public void assign(HttpCookie cookie,
+String attrName,
+String attrValue) {
 if (cookie.getMaxAge() == MAX_AGE_UNSPECIFIED) {
 cookie.setMaxAge(cookie.expiryDate2DeltaSeconds(attrValue));
 }
 }
 });
 }
 private static void assignAttribute(HttpCookie cookie,
 String attrName,
 String attrValue)
 {
 // strip off the surrounding "-sign if there's any
 attrValue = stripOffSurroundingQuote(attrValue);
 CookieAttributeAssignor assignor = assignors.get(attrName.toLowerCase());
 /*
 * Constructs a string representation of this cookie. The string format is
 * as Netscape spec, but without leading "Cookie:" token.
 */
 private String toNetscapeHeaderString() {
-StringBuilder sb = new StringBuilder();
+return getName() + "=" + getValue();
-sb.append(getName() + "=" + getValue());
-return sb.toString();
 }
 /*
 * Constructs a string representation of this cookie. The string format is
 * as RFC 2965/2109, but without leading "Cookie:" token.
 }
 static final TimeZone GMT = TimeZone.getTimeZone("GMT");
 /*
-* @param dateString        a date string in one of the formats
+* @param  dateString
-*                          defined in Netscape cookie spec
+*         a date string in one of the formats defined in Netscape cookie spec
 *
-* @return                  delta seconds between this cookie's creation
+* @return  delta seconds between this cookie's creation time and the time
-*                          time and the time specified by dateString
+*          specified by dateString
 */
 private long expiryDate2DeltaSeconds(String dateString) {
 for (int i = 0; i < COOKIE_DATE_FORMATS.length; i++) {
-SimpleDateFormat df = new SimpleDateFormat(COOKIE_DATE_FORMATS[i], Locale.US);
+SimpleDateFormat df = new SimpleDateFormat(COOKIE_DATE_FORMATS[i],
+Locale.US);
 df.setTimeZone(GMT);
 try {
 Date date = df.parse(dateString);
 return (date.getTime() - whenCreated) / 1000;
 } catch (Exception e) {
 // Ignore, try the next date format
 }
 }
 return 0;
 }
 /*
 * try to guess the cookie version through set-cookie header string
 */
 private static int guessCookieVersion(String header) {
 * Split cookie header string according to rfc 2965:
 *   1) split where it is a comma;
 *   2) but not the comma surrounding by double-quotes, which is the comma
 *      inside port list or embeded URIs.
 *
-* @param header            the cookie header string to split
+* @param  header
-*
+*         the cookie header string to split
-* @return                  list of strings; never null
+*
-*
+* @return  list of strings; never null
 */
 private static List<String> splitMultiCookies(String header) {
 List<String> cookies = new java.util.ArrayList<String>();
 int quoteCount = 0;
 int p, q;
 for (p = 0, q = 0; p < header.length(); p++) {
 char c = header.charAt(p);
 if (c == '"') quoteCount++;
-if (c == ',' && (quoteCount % 2 == 0)) {      // it is comma and not surrounding by double-quotes
+if (c == ',' && (quoteCount % 2 == 0)) {
+// it is comma and not surrounding by double-quotes
 cookies.add(header.substring(q, p));
 q = p + 1;
 }
 }

changeset 11105	4dcb5baa61f3
parent 10352	edde66d3118f
child 11284	2750cfd2352c