001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.cookie;
029
030import org.apache.http.annotation.Obsolete;
031
032/**
033 * ClientCookie extends the standard {@link Cookie} interface with
034 * additional client specific functionality such ability to retrieve
035 * original cookie attributes exactly as they were specified by the
036 * origin server. This is important for generating the {@code Cookie}
037 * header because some cookie specifications require that the
038 * {@code Cookie} header should include certain attributes only if
039 * they were specified in the {@code Set-Cookie} header.
040 * <p>
041 * Please do not use attributes marked as @Obsolete. They have been rendered
042 * obsolete by RFC 6265.
043 *
044 * @since 4.0
045 */
046public interface ClientCookie extends Cookie {
047
048    @Obsolete
049    public static final String VERSION_ATTR    = "version";
050    public static final String PATH_ATTR       = "path";
051    public static final String DOMAIN_ATTR     = "domain";
052    public static final String MAX_AGE_ATTR    = "max-age";
053    public static final String SECURE_ATTR     = "secure";
054    @Obsolete
055    public static final String COMMENT_ATTR    = "comment";
056    public static final String EXPIRES_ATTR    = "expires";
057
058    @Obsolete
059    public static final String PORT_ATTR       = "port";
060    @Obsolete
061    public static final String COMMENTURL_ATTR = "commenturl";
062    @Obsolete
063    public static final String DISCARD_ATTR    = "discard";
064
065    String getAttribute(String name);
066
067    boolean containsAttribute(String name);
068
069}