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.hc.client5.http.cookie;
28
29 import java.time.Instant;
30 import java.util.Date;
31 import java.util.List;
32
33 /**
34 * This interface represents an abstract store for {@link Cookie}
35 * objects.
36 *
37 * @since 4.0
38 */
39 public interface CookieStore {
40
41 /**
42 * Adds an {@link Cookie}, replacing any existing equivalent cookies.
43 * If the given cookie has already expired it will not be added, but existing
44 * values will still be removed.
45 *
46 * @param cookie the {@link Cookie cookie} to be added
47 */
48 void addCookie(Cookie cookie);
49
50 /**
51 * Returns all cookies contained in this store.
52 *
53 * @return all cookies
54 */
55 List<Cookie> getCookies();
56
57 /**
58 * Removes all of {@link Cookie}s in this store that have expired by
59 * the specified {@link java.util.Date}.
60 *
61 * @return true if any cookies were purged.
62 * @deprecated Use {@link #clearExpired(Instant)}
63 */
64 @Deprecated
65 boolean clearExpired(Date date);
66
67 /**
68 * Removes all of {@link Cookie}s in this store that have expired by
69 * the specified {@link Instant}.
70 *
71 * @return true if any cookies were purged.
72 */
73 @SuppressWarnings("deprecation")
74 default boolean clearExpired(Instant date) {
75 return clearExpired(date != null ? new Date(date.toEpochMilli()) : null);
76 }
77
78 /**
79 * Clears all cookies.
80 */
81 void clear();
82
83 }