SetCookie2.java revision 069490a5ca2fd1988d29daf45d892f47ad665115
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/SetCookie2.java $
3 * $Revision: 578408 $
4 * $Date: 2007-09-22 04:53:57 -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 * This interface represents a <code>SetCookie2</code> response header sent by the
36 * origin server to the HTTP agent in order to maintain a conversational state.
37 *
38 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
39 *
40 * @since 4.0
41 */
42public interface SetCookie2 extends SetCookie {
43
44    /**
45     * If a user agent (web browser) presents this cookie to a user, the
46     * cookie's purpose will be described by the information at this URL.
47     */
48    void setCommentURL(String commentURL);
49
50    /**
51     * Sets the Port attribute. It restricts the ports to which a cookie
52     * may be returned in a Cookie request header.
53     */
54    void setPorts(int[] ports);
55
56    /**
57     * Set the Discard attribute.
58     *
59     * Note: <tt>Discard</tt> attribute overrides <tt>Max-age</tt>.
60     *
61     * @see #isPersistent()
62     */
63    void setDiscard(boolean discard);
64
65}
66
67