View Javadoc

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