|
1 /* |
|
2 * ==================================================================== |
|
3 * |
|
4 * Licensed to the Apache Software Foundation (ASF) under one or more |
|
5 * contributor license agreements. See the NOTICE file distributed with |
|
6 * this work for additional information regarding copyright ownership. |
|
7 * The ASF licenses this file to You under the Apache License, Version 2.0 |
|
8 * (the "License"); you may not use this file except in compliance with |
|
9 * 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, software |
|
14 * distributed under the License is distributed on an "AS IS" BASIS, |
|
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
16 * See the License for the specific language governing permissions and |
|
17 * limitations under the License. |
|
18 * ==================================================================== |
|
19 * |
|
20 * This software consists of voluntary contributions made by many |
|
21 * individuals on behalf of the Apache Software Foundation. For more |
|
22 * information on the Apache Software Foundation, please see |
|
23 * <http://www.apache.org/>. |
|
24 * |
|
25 */ |
|
26 |
|
27 package ch.boye.httpclientandroidlib.client; |
|
28 |
|
29 import java.util.Date; |
|
30 import java.util.List; |
|
31 |
|
32 import ch.boye.httpclientandroidlib.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 } |