1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/SetCookie.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 617193 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-01-31 11:26:47 -0800 (Thu, 31 Jan 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.cookie; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Date; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This interface represents a <code>SetCookie</code> response header sent by the 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * origin server to the HTTP agent in order to maintain a conversational state. 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface SetCookie extends Cookie { 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setValue(String value); 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If a user agent (web browser) presents this cookie to a user, the 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie's purpose will be described using this comment. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param comment 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #getComment() 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setComment(String comment); 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets expiration date. 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p><strong>Note:</strong> the object returned by this method is considered 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * immutable. Changing it (e.g. using setTime()) could result in undefined 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * behaviour. Do so at your peril.</p> 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param expiryDate the {@link Date} after which this cookie is no longer valid. 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see Cookie#getExpiryDate 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setExpiryDate (Date expiryDate); 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the domain attribute. 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param domain The value of the domain attribute 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see Cookie#getDomain 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setDomain(String domain); 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the path attribute. 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param path The value of the path attribute 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see Cookie#getPath 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setPath(String path); 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the secure attribute of the cookie. 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * When <tt>true</tt> the cookie should only be sent 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * using a secure protocol (https). This should only be set when 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the cookie's originating server used a secure protocol to set the 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie's value. 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param secure The value of the secure attribute 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #isSecure() 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setSecure (boolean secure); 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the version of the cookie specification to which this 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie conforms. 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param version the version of the cookie. 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see Cookie#getVersion 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void setVersion(int version); 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 116