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   * This interface represents a {@code Set-Cookie2} response header sent by the
32   * origin server to the HTTP agent in order to maintain a conversational state.
33   *
34   * @since 4.0
35   */
36  public interface SetCookie2 extends SetCookie {
37  
38      /**
39       * If a user agent (web browser) presents this cookie to a user, the
40       * cookie's purpose will be described by the information at this URL.
41       */
42      void setCommentURL(String commentURL);
43  
44      /**
45       * Sets the Port attribute. It restricts the ports to which a cookie
46       * may be returned in a Cookie request header.
47       */
48      void setPorts(int[] ports);
49  
50      /**
51       * Set the Discard attribute.
52       *
53       * Note: {@code Discard} attribute overrides {@code Max-age}.
54       *
55       * @see #isPersistent()
56       */
57      void setDiscard(boolean discard);
58  
59  }
60