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.impl.cache;
28
29 import org.apache.hc.core5.http.HttpRequest;
30 import org.apache.hc.core5.http.HttpVersion;
31 import org.apache.hc.core5.http.Method;
32 import org.apache.hc.core5.http.ProtocolVersion;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
35
36 /**
37 * Determines if an HttpRequest is allowed to be served from the cache.
38 */
39 class CacheableRequestPolicy {
40
41 private static final Logger LOG = LoggerFactory.getLogger(CacheableRequestPolicy.class);
42
43 /**
44 * Determines if an HttpRequest can be served from the cache.
45 *
46 * @param request
47 * an HttpRequest
48 * @return boolean Is it possible to serve this request from cache
49 */
50 public boolean canBeServedFromCache(final RequestCacheControl cacheControl, final HttpRequest request) {
51 final String method = request.getMethod();
52
53 final ProtocolVersion pv = request.getVersion() != null ? request.getVersion() : HttpVersion.DEFAULT;
54 if (HttpVersion.HTTP_1_1.compareToVersion(pv) != 0) {
55 LOG.debug("non-HTTP/1.1 request cannot be served from cache");
56 return false;
57 }
58
59 if (!Method.GET.isSame(method) && !Method.HEAD.isSame(method)) {
60 if (LOG.isDebugEnabled()) {
61 LOG.debug("{} request cannot be served from cache", method);
62 }
63 return false;
64 }
65
66 if (cacheControl.isNoStore()) {
67 LOG.debug("Request with no-store cannot be served from cache");
68 return false;
69 }
70 if (cacheControl.isNoCache()) {
71 LOG.debug("Request with no-cache cannot be served from cache");
72 return false;
73 }
74 LOG.debug("Request can be served from cache");
75 return true;
76 }
77
78 }