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.cache;
28
29 import org.apache.hc.client5.http.protocol.HttpClientContext;
30 import org.apache.hc.core5.http.protocol.BasicHttpContext;
31 import org.apache.hc.core5.http.protocol.HttpContext;
32
33 /**
34 * Adaptor class that provides convenience type safe setters and getters
35 * for caching {@link HttpContext} attributes.
36 *
37 * @since 4.3
38 */
39 public class HttpCacheContext extends HttpClientContext {
40
41 /**
42 * This is the name under which the {@link CacheResponseStatus} of a request
43 * (for example, whether it resulted in a cache hit) will be recorded if an
44 * {@link HttpContext} is provided during execution.
45 */
46 public static final String CACHE_RESPONSE_STATUS = "http.cache.response.status";
47
48 public static HttpCacheContext adapt(final HttpContext context) {
49 if (context instanceof HttpCacheContext) {
50 return (HttpCacheContext) context;
51 } else {
52 return new HttpCacheContext(context);
53 }
54 }
55
56 public static HttpCacheContext create() {
57 return new HttpCacheContext(new BasicHttpContext());
58 }
59
60 public HttpCacheContext(final HttpContext context) {
61 super(context);
62 }
63
64 public HttpCacheContext() {
65 super();
66 }
67
68 public CacheResponseStatus getCacheResponseStatus() {
69 return getAttribute(CACHE_RESPONSE_STATUS, CacheResponseStatus.class);
70 }
71
72 }