Home | History | Annotate | Download | only in cookie
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/SetCookie.java $
      3  * $Revision: 617193 $
      4  * $Date: 2008-01-31 11:26:47 -0800 (Thu, 31 Jan 2008) $
      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 
     32 package org.apache.http.cookie;
     33 
     34 import java.util.Date;
     35 
     36 /**
     37  * This interface represents a <code>SetCookie</code> response header sent by the
     38  * origin server to the HTTP agent in order to maintain a conversational state.
     39  *
     40  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     41  *
     42  * @since 4.0
     43  *
     44  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     45  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     46  *     for further details.
     47  */
     48 @Deprecated
     49 public interface SetCookie extends Cookie {
     50 
     51     void setValue(String value);
     52 
     53     /**
     54      * If a user agent (web browser) presents this cookie to a user, the
     55      * cookie's purpose will be described using this comment.
     56      *
     57      * @param comment
     58      *
     59      * @see #getComment()
     60      */
     61     void setComment(String comment);
     62 
     63     /**
     64      * Sets expiration date.
     65      * <p><strong>Note:</strong> the object returned by this method is considered
     66      * immutable. Changing it (e.g. using setTime()) could result in undefined
     67      * behaviour. Do so at your peril.</p>
     68      *
     69      * @param expiryDate the {@link Date} after which this cookie is no longer valid.
     70      *
     71      * @see Cookie#getExpiryDate
     72      *
     73      */
     74     void setExpiryDate (Date expiryDate);
     75 
     76     /**
     77      * Sets the domain attribute.
     78      *
     79      * @param domain The value of the domain attribute
     80      *
     81      * @see Cookie#getDomain
     82      */
     83     void setDomain(String domain);
     84 
     85     /**
     86      * Sets the path attribute.
     87      *
     88      * @param path The value of the path attribute
     89      *
     90      * @see Cookie#getPath
     91      *
     92      */
     93     void setPath(String path);
     94 
     95     /**
     96      * Sets the secure attribute of the cookie.
     97      * <p>
     98      * When <tt>true</tt> the cookie should only be sent
     99      * using a secure protocol (https).  This should only be set when
    100      * the cookie's originating server used a secure protocol to set the
    101      * cookie's value.
    102      *
    103      * @param secure The value of the secure attribute
    104      *
    105      * @see #isSecure()
    106      */
    107     void setSecure (boolean secure);
    108 
    109     /**
    110      * Sets the version of the cookie specification to which this
    111      * cookie conforms.
    112      *
    113      * @param version the version of the cookie.
    114      *
    115      * @see Cookie#getVersion
    116      */
    117     void setVersion(int version);
    118 
    119 }
    120 
    121