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/impl/client/BasicCookieStore.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 653041 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-05-03 03:39:28 -0700 (Sat, 03 May 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 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, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.client; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.ArrayList; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Collections; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Comparator; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Date; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.Iterator; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.List; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.client.CookieStore; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.Cookie; 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.CookieIdentityComparator; 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Default implementation of {@link CookieStore} 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:remm@apache.org">Remy Maucherat</a> 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Rodney Waldhoff 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Sean C. Sullivan 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a> 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:adrian@intencha.com">Adrian Sutton</a> 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class BasicCookieStore implements CookieStore { 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final ArrayList<Cookie> cookies; 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final Comparator<Cookie> cookieComparator; 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // -------------------------------------------------------- Class Variables 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Default constructor. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public BasicCookieStore() { 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.cookies = new ArrayList<Cookie>(); 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.cookieComparator = new CookieIdentityComparator(); 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the given cookie has already expired it will not be added, but existing 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * values will still be removed. 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookie the {@link Cookie cookie} to be added 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #addCookies(Cookie[]) 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void addCookie(Cookie cookie) { 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie != null) { 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // first remove any old cookie that is equivalent 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (Iterator<Cookie> it = cookies.iterator(); it.hasNext();) { 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookieComparator.compare(cookie, it.next()) == 0) { 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project it.remove(); 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project break; 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!cookie.isExpired(new Date())) { 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project cookies.add(cookie); 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in the given array order. If any of the given cookies has already expired it will 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * not be added, but existing values will still be removed. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param cookies the {@link Cookie cookies} to be added 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #addCookie(Cookie) 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void addCookies(Cookie[] cookies) { 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookies != null) { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (Cookie cooky : cookies) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.addCookie(cooky); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns an immutable array of {@link Cookie cookies} that this HTTP 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * state currently contains. 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return an array of {@link Cookie cookies}. 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized List<Cookie> getCookies() { 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return Collections.unmodifiableList(this.cookies); 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Removes all of {@link Cookie cookies} in this HTTP state 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that have expired by the specified {@link java.util.Date date}. 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return true if any cookies were purged. 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see Cookie#isExpired(Date) 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized boolean clearExpired(final Date date) { 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (date == null) { 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean removed = false; 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (Iterator<Cookie> it = cookies.iterator(); it.hasNext();) { 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (it.next().isExpired(date)) { 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project it.remove(); 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project removed = true; 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return removed; 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String toString() { 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return cookies.toString(); 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Clears all cookies. 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public synchronized void clear() { 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project cookies.clear(); 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 163