|
Jetty example source code file (Cookie.java)
The Jetty Cookie.java source code/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * glassfish/bootstrap/legal/CDDLv1.0.txt or * https://glassfish.dev.java.net/public/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable, * add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your * own identifying information: Portions Copyright [yyyy] * [name of copyright owner] * * Copyright 2005 Sun Microsystems, Inc. All rights reserved. * * Portions Copyright Apache Software Foundation. */ package javax.servlet.http; import java.text.MessageFormat; import java.util.ResourceBundle; /** * * Creates a cookie, a small amount of information sent by a servlet to * a Web browser, saved by the browser, and later sent back to the server. * A cookie's value can uniquely * identify a client, so cookies are commonly used for session management. * * <p>A cookie has a name, a single value, and optional attributes * such as a comment, path and domain qualifiers, a maximum age, and a * version number. Some Web browsers have bugs in how they handle the * optional attributes, so use them sparingly to improve the interoperability * of your servlets. * * <p>The servlet sends cookies to the browser by using the * {@link HttpServletResponse#addCookie} method, which adds * fields to HTTP response headers to send cookies to the * browser, one at a time. The browser is expected to * support 20 cookies for each Web server, 300 cookies total, and * may limit cookie size to 4 KB each. * * <p>The browser returns cookies to the servlet by adding * fields to HTTP request headers. Cookies can be retrieved * from a request by using the {@link HttpServletRequest#getCookies} method. * Several cookies might have the same name but different path attributes. * * <p>Cookies affect the caching of the Web pages that use them. * HTTP 1.0 does not cache pages that use cookies created with * this class. This class does not support the cache control * defined with HTTP 1.1. * * <p>This class supports both the Version 0 (by Netscape) and Version 1 * (by RFC 2109) cookie specifications. By default, cookies are * created using Version 0 to ensure the best interoperability. * * * @author Various */ // XXX would implement java.io.Serializable too, but can't do that // so long as sun.servlet.* must run on older JDK 1.02 JVMs which // don't include that support. public class Cookie implements Cloneable { private static final String LSTRING_FILE = "javax.servlet.http.LocalStrings"; private static ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE); // // The value of the cookie itself. // 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 // ;Discard ... implied by maxAge < 0 private String domain; // ;Domain=VALUE ... domain that sees cookie private int maxAge = -1; // ;Max-Age=VALUE ... cookies auto-expire private String path; // ;Path=VALUE ... URLs that see the cookie private boolean secure; // ;Secure ... e.g. use SSL private int version = 0; // ;Version=1 ... means RFC 2109++ style /** * Constructs a cookie with a specified name and value. * * <p>The name must conform to RFC 2109. 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 * value is probably of interest only to the server. The cookie's * value can be changed after creation with the * <code>setValue method. * * <p>By default, cookies are created according to the Netscape * cookie specification. The version can be changed with the * <code>setVersion method. * * * @param name a <code>String specifying the name of the cookie * * @param value a <code>String specifying the value of the cookie * * @throws IllegalArgumentException if the cookie name contains illegal characters * (for example, a comma, space, or semicolon) * or it is one of the tokens reserved for use * by the cookie protocol * @see #setValue * @see #setVersion * */ public Cookie(String name, String value) { if (!isToken(name) || name.equalsIgnoreCase("Comment") // rfc2019 || name.equalsIgnoreCase("Discard") // 2019++ || name.equalsIgnoreCase("Domain") || name.equalsIgnoreCase("Expires") // (old cookies) || name.equalsIgnoreCase("Max-Age") // rfc2019 || name.equalsIgnoreCase("Path") || name.equalsIgnoreCase("Secure") || name.equalsIgnoreCase("Version") || name.startsWith("$") ) { String errMsg = lStrings.getString("err.cookie_name_is_token"); Object[] errArgs = new Object[1]; errArgs[0] = name; errMsg = MessageFormat.format(errMsg, errArgs); throw new IllegalArgumentException(errMsg); } this.name = name; this.value = value; } /** * * Specifies a comment that describes a cookie's purpose. * The comment is useful if the browser presents the cookie * to the user. Comments * are not supported by Netscape Version 0 cookies. * * @param purpose a <code>String specifying the comment * to display to the user * * @see #getComment * */ public void setComment(String purpose) { comment = purpose; } /** * Returns the comment describing the purpose of this cookie, or * <code>null if the cookie has no comment. * * @return a <code>String containing the comment, * or <code>null if none * * @see #setComment * */ public String getComment() { return comment; } /** * * Specifies the domain within which this cookie should be presented. * * <p>The form of the domain name is specified by RFC 2109. A domain * 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, but not * <code>a.b.foo.com). By default, cookies are only returned * to the server that sent them. * * * @param pattern a <code>String containing the domain name * within which this cookie is visible; * form is according to RFC 2109 * * @see #getDomain * */ public void setDomain(String pattern) { domain = pattern.toLowerCase(); // IE allegedly needs this } /** * Returns the domain name set for this cookie. The form of * the domain name is set by RFC 2109. * * @return a <code>String 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 * after that many seconds have passed. Note that the value is * the <i>maximum age when the cookie will expire, not the cookie's * current age. * * <p>A negative value means * that the cookie is not stored persistently and will be deleted * when the Web browser exits. A zero value causes the cookie * to be deleted. * * @param expiry an integer specifying the maximum age of the * cookie in seconds; if negative, means * the cookie is not stored; if zero, deletes * the cookie * * * @see #getMaxAge * */ public void setMaxAge(int 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. * * * @return an integer specifying the maximum age of the * cookie in seconds; if negative, means * the cookie persists until browser shutdown * * * @see #setMaxAge * */ public int getMaxAge() { return maxAge; } /** * Specifies a path for the cookie * 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, which makes the cookie * visible to all directories on the server under <i>/catalog. * * <p>Consult RFC 2109 (available on the Internet) for more * information on setting path names for cookies. * * * @param uri a <code>String specifying a path * * * @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. * * * @return a <code>String specifying a path that contains * a servlet name, for example, <i>/catalog * * @see #setPath * */ public String getPath() { return path; } /** * Indicates to the browser whether the cookie should only be sent * using a secure protocol, such as HTTPS or SSL. * * <p>The default value is Other Jetty examples (source code examples)Here is a short list of links related to this Jetty Cookie.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.