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 import org.apache.http.annotation.Obsolete;
31
32 /**
33 * ClientCookie extends the standard {@link Cookie} interface with
34 * additional client specific functionality such ability to retrieve
35 * original cookie attributes exactly as they were specified by the
36 * origin server. This is important for generating the {@code Cookie}
37 * header because some cookie specifications require that the
38 * {@code Cookie} header should include certain attributes only if
39 * they were specified in the {@code Set-Cookie} header.
40 * <p>
41 * Please do not use attributes marked as @Obsolete. They have been rendered
42 * obsolete by RFC 6265.
43 *
44 * @since 4.0
45 */
46 public interface ClientCookie extends Cookie {
47
48 @Obsolete String VERSION_ATTR = "version";
49 String PATH_ATTR = "path";
50 String DOMAIN_ATTR = "domain";
51 String MAX_AGE_ATTR = "max-age";
52 String SECURE_ATTR = "secure";
53 @Obsolete String COMMENT_ATTR = "comment";
54 String EXPIRES_ATTR = "expires";
55
56 @Obsolete String PORT_ATTR = "port";
57 @Obsolete String COMMENTURL_ATTR = "commenturl";
58 @Obsolete String DISCARD_ATTR = "discard";
59
60 String getAttribute(String name);
61
62 boolean containsAttribute(String name);
63
64 }