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/Cookie.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 578403 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-09-22 03:56:04 -0700 (Sat, 22 Sep 2007) $ 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 * HTTP "magic-cookie" represents a piece of state information 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that the HTTP agent and the target server can exchange to maintain 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * a session. 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface Cookie { 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the name. 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return String name The name 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getName(); 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the value. 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return String value The current value. 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getValue(); 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the comment describing the purpose of this cookie, or 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <tt>null</tt> if no such comment has been defined. 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return comment 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getComment(); 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If a user agent (web browser) presents this cookie to a user, the 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie's purpose will be described by the information at this URL. 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getCommentURL(); 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the expiration {@link Date} of the cookie, or <tt>null</tt> 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if none exists. 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p><strong>Note:</strong> the object returned by this method is 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * considered immutable. Changing it (e.g. using setTime()) could result 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in undefined behaviour. Do so at your peril. </p> 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return Expiration {@link Date}, or <tt>null</tt>. 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Date getExpiryDate(); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns <tt>false</tt> if the cookie should be discarded at the end 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * of the "session"; <tt>true</tt> otherwise. 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <tt>false</tt> if the cookie should be discarded at the end 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * of the "session"; <tt>true</tt> otherwise 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean isPersistent(); 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns domain attribute of the cookie. 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the value of the domain attribute 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getDomain(); 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the path attribute of the cookie 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The value of the path attribute. 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String getPath(); 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Get the Port attribute. It restricts the ports to which a cookie 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * may be returned in a Cookie request header. 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int[] getPorts(); 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Indicates whether this cookie requires a secure connection. 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <code>true</code> if this cookie should only be sent 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * over secure connections, <code>false</code> otherwise. 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean isSecure(); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the version of the cookie specification to which this 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie conforms. 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the version of the cookie. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int getVersion(); 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns true if this cookie has expired. 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param date Current time 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <tt>true</tt> if the cookie has expired. 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean isExpired(final Date date); 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 140