1 /* 2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/CookieStore.java $ 3 * $Revision: 604434 $ 4 * $Date: 2007-12-15 06:45:48 -0800 (Sat, 15 Dec 2007) $ 5 * 6 * ==================================================================== 7 * 8 * Licensed to the Apache Software Foundation (ASF) under one or more 9 * contributor license agreements. See the NOTICE file distributed with 10 * this work for additional information regarding copyright ownership. 11 * The ASF licenses this file to You under the Apache License, Version 2.0 12 * (the "License"); you may not use this file except in compliance with 13 * the License. You may obtain a copy of the License at 14 * 15 * http://www.apache.org/licenses/LICENSE-2.0 16 * 17 * Unless required by applicable law or agreed to in writing, software 18 * distributed under the License is distributed on an "AS IS" BASIS, 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20 * See the License for the specific language governing permissions and 21 * limitations under the License. 22 * ==================================================================== 23 * 24 * This software consists of voluntary contributions made by many 25 * individuals on behalf of the Apache Software Foundation. For more 26 * information on the Apache Software Foundation, please see 27 * <http://www.apache.org/>. 28 * 29 */ 30 31 package org.apache.http.client; 32 33 import java.util.Date; 34 import java.util.List; 35 36 import org.apache.http.cookie.Cookie; 37 38 /** 39 * Abstract cookie store. 40 * 41 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42 * 43 * @since 4.0 44 */ 45 public interface CookieStore { 46 47 /** 48 * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies. 49 * If the given cookie has already expired it will not be added, but existing 50 * values will still be removed. 51 * 52 * @param cookie the {@link Cookie cookie} to be added 53 */ addCookie(Cookie cookie)54 void addCookie(Cookie cookie); 55 56 /** 57 * Returns all cookies contained in this store. 58 * 59 * @return all cookies 60 */ getCookies()61 List<Cookie> getCookies(); 62 63 /** 64 * Removes all of {@link Cookie cookies} in this store that have expired by 65 * the specified {@link java.util.Date date}. 66 * 67 * @return true if any cookies were purged. 68 */ clearExpired(Date date)69 boolean clearExpired(Date date); 70 71 /** 72 * Clears all cookies. 73 */ clear()74 void clear(); 75 76 } 77