michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client;
michael@0: 
michael@0: import java.util.Date;
michael@0: import java.util.List;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.cookie.Cookie;
michael@0: 
michael@0: /**
michael@0:  * This interface represents an abstract store for {@link Cookie}
michael@0:  * objects.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface CookieStore {
michael@0: 
michael@0:     /**
michael@0:      * Adds an {@link Cookie}, replacing any existing equivalent cookies.
michael@0:      * If the given cookie has already expired it will not be added, but existing
michael@0:      * values will still be removed.
michael@0:      *
michael@0:      * @param cookie the {@link Cookie cookie} to be added
michael@0:      */
michael@0:     void addCookie(Cookie cookie);
michael@0: 
michael@0:     /**
michael@0:      * Returns all cookies contained in this store.
michael@0:      *
michael@0:      * @return all cookies
michael@0:      */
michael@0:     List<Cookie> getCookies();
michael@0: 
michael@0:     /**
michael@0:      * Removes all of {@link Cookie}s in this store that have expired by
michael@0:      * the specified {@link java.util.Date}.
michael@0:      *
michael@0:      * @return true if any cookies were purged.
michael@0:      */
michael@0:     boolean clearExpired(Date date);
michael@0: 
michael@0:     /**
michael@0:      * Clears all cookies.
michael@0:      */
michael@0:     void clear();
michael@0: 
michael@0: }