View Javadoc

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