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/CookieAttributeHandler.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 558519 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-07-22 11:19:49 -0700 (Sun, 22 Jul 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 Projectpackage org.apache.http.cookie; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Ths interface represents a cookie attribute handler responsible 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * for parsing, validating, and matching a specific cookie attribute, 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * such as path, domain, port, etc. 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Different cookie specifications can provide a specific 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * implementation for this class based on their cookie handling 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * rules. 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author jain.samit@gmail.com (Samit Jain) 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 45d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 46d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 47d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 48d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 50d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface CookieAttributeHandler { 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Parse the given cookie attribute value and update the corresponding 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link org.apache.http.cookie.Cookie} property. 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie {@link org.apache.http.cookie.Cookie} to be updated 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param value cookie attribute value from the cookie response header 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void parse(SetCookie cookie, String value) 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws MalformedCookieException; 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Peforms cookie validation for the given attribute value. 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie {@link org.apache.http.cookie.Cookie} to validate 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param origin the cookie source to validate against 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws MalformedCookieException if cookie validation fails for this attribute 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void validate(Cookie cookie, CookieOrigin origin) 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws MalformedCookieException; 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Matches the given value (property of the destination host where request is being 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * submitted) with the corresponding cookie attribute. 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie {@link org.apache.http.cookie.Cookie} to match 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param origin the cookie source to match against 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <tt>true</tt> if the match is successful; <tt>false</tt> otherwise 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean match(Cookie cookie, CookieOrigin origin); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 84