Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  *
  *
  * This file incorporates work covered by the following copyright and
  * permission notice:
  *
  * Copyright 2004 The Apache Software Foundation
  *
  * 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 javax.servlet.http;
 
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.

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.

The servlet sends cookies to the browser by using the HttpServletResponse.addCookie(javax.servlet.http.Cookie) 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.

The browser returns cookies to the servlet by adding fields to HTTP request headers. Cookies can be retrieved from a request by using the HttpServletRequest.getCookies() method. Several cookies might have the same name but different path attributes.

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.

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(s):
Various
public class Cookie implements CloneableSerializable {
    private static final long serialVersionUID = -6454587001725327448L;
    private static final String TSPECIALS;
    private static final String LSTRING_FILE =
        "javax.servlet.http.LocalStrings";
    private static ResourceBundle lStrings =
        ResourceBundle.getBundle();
    static {
        if (Boolean.valueOf(System.getProperty(
                "org.glassfish.web.rfc2109_cookie_names_enforced",
                "true")).booleanValue()) {
             = "/()<>@,;:\\\"[]?={} \t";
        } else {
             = ",; ";
        }
    }
    
    //
    // 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
    private boolean isHttpOnly = false;

    
Constructs a cookie with the specified name and value.

The name must conform to RFC 2109. However, vendors may provide a configuration option that allows cookie names conforming to the original Netscape Cookie Specification to be accepted.

The name of a cookie cannot be changed once the cookie has been created.

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 setValue method.

By default, cookies are created according to the Netscape cookie specification. The version can be changed with the setVersion method.

Parameters:
name the name of the cookie
value the value of the cookie
Throws:
java.lang.IllegalArgumentException if the cookie name is null or empty or contains any illegal characters (for example, a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol
See also:
setValue(java.lang.String)
setVersion(int)
    public Cookie(String nameString value) {
        if (name == null || name.length() == 0) {
            throw new IllegalArgumentException(
                    .getString("err.cookie_name_blank"));
        }
        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 = .getString("err.cookie_name_is_token");
            Object[] errArgs = new Object[1];
            errArgs[0] = name;
            errMsg = MessageFormat.format(errMsgerrArgs);
            throw new IllegalArgumentException(errMsg);
        }
        this. = name;
        this. = 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.

Parameters:
purpose a String specifying the comment to display to the user
See also:
getComment()
    public void setComment(String purpose) {
         = purpose;
    }

    
Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.

Returns:
the comment of the cookie, or null if unspecified
See also:
setComment(java.lang.String)
 
    public String getComment() {
        return ;
    }
    
    
Specifies the domain within which this cookie should be presented.

The form of the domain name is specified by RFC 2109. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.

Parameters:
domain the domain name within which this cookie is visible; form is according to RFC 2109
See also:
getDomain()
    public void setDomain(String domain) {
        this. = domain.toLowerCase(.); // IE allegedly needs this
    }

    
Gets the domain name of this Cookie.

Domain names are formatted according to RFC 2109.

Returns:
the domain name of this Cookie
See also:
setDomain(java.lang.String)
 
    public String getDomain() {
        return ;
    }

    
Sets the maximum age in seconds for this Cookie.

A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.

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.

Parameters:
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 also:
getMaxAge()
    public void setMaxAge(int expiry) {
         = expiry;
    }

    
Gets the maximum age in seconds of this Cookie.

By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.

Returns:
an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown
See also:
setMaxAge(int)
    public int getMaxAge() {
        return ;
    }
    
    
Specifies a path for the cookie to which the client should return the cookie.

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, /catalog, which makes the cookie visible to all directories on the server under /catalog.

Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.

Parameters:
uri a String specifying a path
See also:
getPath()
    public void setPath(String uri) {
         = 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:
a String specifying a path that contains a servlet name, for example, /catalog
See also:
setPath(java.lang.String)
 
    public String getPath() {
        return ;
    }

    
Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

The default value is false.

Parameters:
flag if true, sends the cookie from the browser to the server only when using a secure protocol; if false, sent on any protocol
See also:
getSecure()
    public void setSecure(boolean flag) {
         = flag;
    }

    
Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

Returns:
true if the browser uses a secure protocol, false otherwise
See also:
setSecure(boolean)
    public boolean getSecure() {
        return ;
    }

    
Returns the name of the cookie. The name cannot be changed after creation.

Returns:
the name of the cookie
    public String getName() {
        return ;
    }

    
Assigns a new value to this Cookie.

If you use a binary value, you may want to use BASE64 encoding.

With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.

Parameters:
newValue the new value of the cookie
See also:
getValue()
    public void setValue(String newValue) {
         = newValue;
    }

    
Gets the current value of this Cookie.

Returns:
the current value of this Cookie
See also:
setValue(java.lang.String)
    public String getValue() {
        return ;
    }

    
Returns the version of the protocol this cookie complies with. Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.

Returns:
0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2109
See also:
setVersion(int)
    public int getVersion() {
        return ;
    }

    
Sets the version of the cookie protocol that this Cookie complies with.

Version 0 complies with the original Netscape cookie specification. Version 1 complies with RFC 2109.

Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.

Parameters:
v 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109
See also:
getVersion()
    public void setVersion(int v) {
         = v;
    }
    /*
     * Tests a string and returns true if the string counts as a 
     * reserved token in the Java language.
     * 
     * @param value the <code>String</code> to be tested
     *
     * @return <code>true</code> if the <code>String</code> is a reserved
     * token; <code>false</code> otherwise
     */
    private boolean isToken(String value) {
        int len = value.length();
        for (int i = 0; i < leni++) {
            char c = value.charAt(i);
            if (c < 0x20 || c >= 0x7f || .indexOf(c) != -1) {
                return false;
            }
        }
        return true;
    }

    
Overrides the standard java.lang.Object.clone method to return a copy of this Cookie.
    public Object clone() {
        try {
            return super.clone();
        } catch (CloneNotSupportedException e) {
            throw new RuntimeException(e.getMessage());
        }
    }

    
Marks or unmarks this Cookie as HttpOnly.

If isHttpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it.

HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.

Parameters:
isHttpOnly true if this cookie is to be marked as HttpOnly, false otherwise
Since:
Servlet 3.0
    public void setHttpOnly(boolean isHttpOnly) {
        this. = isHttpOnly;
    }
 
    
Checks whether this Cookie has been marked as HttpOnly.

Returns:
true if this Cookie has been marked as HttpOnly, false otherwise
Since:
Servlet 3.0
    public boolean isHttpOnly() {
        return ;
    }
New to GrepCode? Check out our FAQ X