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
28 package org.apache.hc.client5.http.impl.cache;
29
30 import org.apache.hc.core5.annotation.Contract;
31 import org.apache.hc.core5.annotation.Internal;
32 import org.apache.hc.core5.annotation.ThreadingBehavior;
33
34 /**
35 * Represents the values of the Cache-Control header in an HTTP message, which indicate whether and for how long
36 * the response can be cached by the client and intermediary proxies.
37 *
38 * @since 5.3
39 */
40 @Internal
41 @Contract(threading = ThreadingBehavior.IMMUTABLE)
42 interface CacheControl {
43
44 /**
45 * Returns the max-age value from the Cache-Control header.
46 *
47 * @return The max-age value.
48 */
49 long getMaxAge();
50
51 /**
52 * Returns the no-cache flag from the Cache-Control header.
53 *
54 * @return The no-cache flag.
55 */
56 boolean isNoCache();
57
58 /**
59 * Returns the no-store flag from the Cache-Control header.
60 *
61 * @return The no-store flag.
62 */
63 boolean isNoStore();
64
65 /**
66 * Returns the stale-if-error value from the Cache-Control header.
67 *
68 * @return The stale-if-error value.
69 */
70 long getStaleIfError();
71 }