michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.cookie;
michael@0: 
michael@0: import java.util.Date;
michael@0: 
michael@0: /**
michael@0:  * This interface represents a <code>Set-Cookie</code> response header sent by the
michael@0:  * origin server to the HTTP agent in order to maintain a conversational state.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface SetCookie extends Cookie {
michael@0: 
michael@0:     void setValue(String value);
michael@0: 
michael@0:     /**
michael@0:      * If a user agent (web browser) presents this cookie to a user, the
michael@0:      * cookie's purpose will be described using this comment.
michael@0:      *
michael@0:      * @param comment
michael@0:      *
michael@0:      * @see #getComment()
michael@0:      */
michael@0:     void setComment(String comment);
michael@0: 
michael@0:     /**
michael@0:      * Sets expiration date.
michael@0:      * <p><strong>Note:</strong> the object returned by this method is considered
michael@0:      * immutable. Changing it (e.g. using setTime()) could result in undefined
michael@0:      * behaviour. Do so at your peril.</p>
michael@0:      *
michael@0:      * @param expiryDate the {@link Date} after which this cookie is no longer valid.
michael@0:      *
michael@0:      * @see Cookie#getExpiryDate
michael@0:      *
michael@0:      */
michael@0:     void setExpiryDate (Date expiryDate);
michael@0: 
michael@0:     /**
michael@0:      * Sets the domain attribute.
michael@0:      *
michael@0:      * @param domain The value of the domain attribute
michael@0:      *
michael@0:      * @see Cookie#getDomain
michael@0:      */
michael@0:     void setDomain(String domain);
michael@0: 
michael@0:     /**
michael@0:      * Sets the path attribute.
michael@0:      *
michael@0:      * @param path The value of the path attribute
michael@0:      *
michael@0:      * @see Cookie#getPath
michael@0:      *
michael@0:      */
michael@0:     void setPath(String path);
michael@0: 
michael@0:     /**
michael@0:      * Sets the secure attribute of the cookie.
michael@0:      * <p>
michael@0:      * When <tt>true</tt> the cookie should only be sent
michael@0:      * using a secure protocol (https).  This should only be set when
michael@0:      * the cookie's originating server used a secure protocol to set the
michael@0:      * cookie's value.
michael@0:      *
michael@0:      * @param secure The value of the secure attribute
michael@0:      *
michael@0:      * @see #isSecure()
michael@0:      */
michael@0:     void setSecure (boolean secure);
michael@0: 
michael@0:     /**
michael@0:      * Sets the version of the cookie specification to which this
michael@0:      * cookie conforms.
michael@0:      *
michael@0:      * @param version the version of the cookie.
michael@0:      *
michael@0:      * @see Cookie#getVersion
michael@0:      */
michael@0:     void setVersion(int version);
michael@0: 
michael@0: }
michael@0: