View Javadoc

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