Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright 2003-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. 
16
 
17
 
18
 //
19
 // This source code implements specifications defined by the Java
20
 // Community Process. In order to remain compliant with the specification
21
 // DO NOT add / change / or delete method signatures!
22
 //
23
 
24
 package javax.servlet.http;
25
 
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.

Version:
$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $
63
 
64
 
65
 // XXX would implement java.io.Serializable too, but can't do that
66
 // so long as sun.servlet.* must run on older JDK 1.02 JVMs which
67
 // don't include that support.
68
 
69
 public class Cookie implements Cloneable {
70
     private static final String LSTRING_FILE = "javax.servlet.http.LocalStrings";
71
     private static ResourceBundle lStrings = ResourceBundle.getBundle();
72
 
73
     //
74
     // The value of the cookie itself.
75
     //
76
 
77
     private String name; // NAME= ... "$Name" style is reserved
78
     private String value; // value of NAME
79
 
80
     //
81
     // Attributes encoded in the header's cookie fields.
82
     //
83
 
84
     private String comment; // ;Comment=VALUE ... describes cookie's use
85
     // ;Discard ... implied by maxAge < 0
86
     private String domain; // ;Domain=VALUE ... domain that sees cookie
87
     private int maxAge = -1; // ;Max-Age=VALUE ... cookies auto-expire
88
     private String path; // ;Path=VALUE ... URLs that see the cookie
89
     private boolean secure; // ;Secure ... e.g. use SSL
90
     private int version = 0; // ;Version=1 ... means RFC 2109++ style
91
 

    
Constructs a cookie with a specified name and value.

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.

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 a String specifying the name of the cookie
value a String specifying the value of the cookie
Throws:
java.lang.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 also:
setValue(java.lang.String)
setVersion(int)
122
    public Cookie(String name, String value) {
123
        if (!isToken(name)
124
                || name.equalsIgnoreCase("Comment") // rfc2019
125
                || name.equalsIgnoreCase("Discard") // 2019++
126
                || name.equalsIgnoreCase("Domain")
127
                || name.equalsIgnoreCase("Expires") // (old cookies)
128
                || name.equalsIgnoreCase("Max-Age") // rfc2019
129
                || name.equalsIgnoreCase("Path")
130
                || name.equalsIgnoreCase("Secure")
131
                || name.equalsIgnoreCase("Version")
132
                || name.startsWith("$")
133
        ) {
134
            String errMsg = .getString("err.cookie_name_is_token");
135
            Object[] errArgs = new Object[1];
136
            errArgs[0] = name;
137
            errMsg = MessageFormat.format(errMsg, errArgs);
138
            throw new IllegalArgumentException(errMsg);
139
        }
141
        this. = name;
142
        this. = value;
143
    }

    
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()
156
    public void setComment(String purpose) {
157
         = purpose;
158
    }

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

Returns:
a String containing the comment, or null if none
See also:
setComment(java.lang.String)
169
    public String getComment() {
170
        return ;
171
    }

    
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:
pattern a String containing the domain name within which this cookie is visible; form is according to RFC 2109
See also:
getDomain()
188
    public void setDomain(String pattern) {
189
         = pattern.toLowerCase(); // IE allegedly needs this
190
    }

    
Returns the domain name set for this cookie. The form of the domain name is set by RFC 2109.

Returns:
a String containing the domain name
See also:
setDomain(java.lang.String)
200
    public String getDomain() {
201
        return ;
202
    }

    
Sets the maximum age of the cookie in seconds.

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()
223
    public void setMaxAge(int expiry) {
224
         = expiry;
225
    }

    
Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating 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)
238
    public int getMaxAge() {
239
        return ;
240
    }

    
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()
259
    public void setPath(String uri) {
260
         = uri;
261
    }

    
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)
273
    public String getPath() {
274
        return ;
275
    }

    
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()
289
    public void setSecure(boolean flag) {
290
         = flag;
291
    }

    
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; otherwise, true
See also:
setSecure(boolean)
303
    public boolean getSecure() {
304
        return ;
305
    }

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

Returns:
a String specifying the cookie's name
313
    public String getName() {
314
        return ;
315
    }

    
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.

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 a String specifying the new value
See also:
getValue()
Cookie
332
    public void setValue(String newValue) {
333
         = newValue;
334
    }

    
Returns the value of the cookie.

Returns:
a String containing the cookie's present value
See also:
setValue(java.lang.String)
Cookie
345
    public String getValue() {
346
        return ;
347
    }

    
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)
361
    public int getVersion() {
362
        return ;
363
    }

    
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 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()
378
    public void setVersion(int v) {
379
         = v;
380
    }
382
    // Note -- disabled for now to allow full Netscape compatibility
383
    // from RFC 2068, token special case characters
384
    //
385
    // private static final String tspecials = "()<>@,;:\\\"/[]?={} \t";
387
    private static final String tspecials = ",; ";

    
Tests a string and returns true if the string counts as a reserved token in the Java language.

Parameters:
value the String to be tested
Returns:
true if the String is a reserved token; false if it is not
398
    private boolean isToken(String value) {
399
        int len = value.length();
401
        for (int i = 0; i < len; i++) {
402
            char c = value.charAt(i);
404
            if (c < 0x20 || c >= 0x7f || .indexOf(c) != -1)
405
                return false;
406
        }
407
        return true;
408
    }

    
Overrides the standard java.lang.Object.clone method to return a copy of this cookie. 
414
    public Object clone() {
415
        try {
416
            return super.clone();
417
        } catch (CloneNotSupportedException e) {
418
            throw new RuntimeException(e.getMessage());
419
        }
420
    }
New to GrepCode? Check out our FAQ X