001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.client;
028
029import java.util.Date;
030import java.util.List;
031
032import org.apache.http.cookie.Cookie;
033
034/**
035 * This interface represents an abstract store for {@link Cookie}
036 * objects.
037 *
038 * @since 4.0
039 */
040public interface CookieStore {
041
042    /**
043     * Adds an {@link Cookie}, replacing any existing equivalent cookies.
044     * If the given cookie has already expired it will not be added, but existing
045     * values will still be removed.
046     *
047     * @param cookie the {@link Cookie cookie} to be added
048     */
049    void addCookie(Cookie cookie);
050
051    /**
052     * Returns all cookies contained in this store.
053     *
054     * @return all cookies
055     */
056    List<Cookie> getCookies();
057
058    /**
059     * Removes all of {@link Cookie}s in this store that have expired by
060     * the specified {@link java.util.Date}.
061     *
062     * @return true if any cookies were purged.
063     */
064    boolean clearExpired(Date date);
065
066    /**
067     * Clears all cookies.
068     */
069    void clear();
070
071}