ClientCookie.java revision 417f3b92ba4549b2f22340e3107d869d2b9c5bb8 
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/ClientCookie.java $
3 * $Revision: 578403 $
4 * $Date: 2007-09-22 03:56:04 -0700 (Sat, 22 Sep 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http.cookie;
33
34/**
35 * ClientCookie extends the standard {@link Cookie} interface with
36 * additional client specific functionality such ability to retrieve
37 * original cookie attributes exactly as they were specified by the
38 * origin server. This is important for generating the <tt>Cookie</tt>
39 * header because some cookie specifications require that the
40 * <tt>Cookie</tt> header should include certain attributes only if
41 * they were specified in the <tt>Set-Cookie</tt> header.
42 *
43 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
44 *
45 * @since 4.0
46 */
47public interface ClientCookie extends Cookie {
48
49    // RFC2109 attributes
50    public static final String VERSION_ATTR    = "version";
51    public static final String PATH_ATTR       = "path";
52    public static final String DOMAIN_ATTR     = "domain";
53    public static final String MAX_AGE_ATTR    = "max-age";
54    public static final String SECURE_ATTR     = "secure";
55    public static final String COMMENT_ATTR    = "comment";
56    public static final String EXPIRES_ATTR    = "expires";
57
58    // RFC2965 attributes
59    public static final String PORT_ATTR       = "port";
60    public static final String COMMENTURL_ATTR = "commenturl";
61    public static final String DISCARD_ATTR    = "discard";
62
63    String getAttribute(String name);
64
65    boolean containsAttribute(String name);
66
67}