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/CookieSpec.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 603563 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-12-12 03:17:55 -0800 (Wed, 12 Dec 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.List; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.Header; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Defines the cookie management specification. 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p>Cookie management specification must define 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <ul> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <li> rules of parsing "Set-Cookie" header 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <li> rules of validation of parsed cookies 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <li> formatting of "Cookie" header 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </ul> 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * for a given host, port and path of origin 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface CookieSpec { 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns version of the state management this cookie specification 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * conforms to. 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return version of the state management specification 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int getVersion(); 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies. 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p>This method will not perform the validation of the resultant 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link Cookie}s</p> 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #validate 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param header the <tt>Set-Cookie</tt> received from the server 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param origin details of the cookie origin 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return an array of <tt>Cookie</tt>s parsed from the header 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws MalformedCookieException if an exception occurs during parsing 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project List<Cookie> parse(Header header, CookieOrigin origin) throws MalformedCookieException; 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Validate the cookie according to validation rules defined by the 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * cookie specification. 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie the Cookie to validate 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param origin details of the cookie origin 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws MalformedCookieException if the cookie is invalid 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException; 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines if a Cookie matches the target location. 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie the Cookie to be matched 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param origin the target to test against 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <tt>true</tt> if the cookie should be submitted with a request 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with given attributes, <tt>false</tt> otherwise. 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean match(Cookie cookie, CookieOrigin origin); 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Create <tt>"Cookie"</tt> headers for an array of Cookies. 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookies the Cookies format into a Cookie header 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a Header for the given Cookies. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalArgumentException if an input parameter is illegal 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project List<Header> formatCookies(List<Cookie> cookies); 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns a request header identifying what version of the state management 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specification is understood. May be <code>null</code> if the cookie 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specification does not support <tt>Cookie2</tt> header. 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Header getVersionHeader(); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 116