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 /**
30 * This enumeration represents the various ways a response can be generated
31 * by the caching {@link org.apache.hc.client5.http.classic.HttpClient};
32 * if a request is executed with an {@link HttpCacheContext}
33 * then a parameter with one of these values will be registered in the
34 * context under the key {@link HttpCacheContext#CACHE_RESPONSE_STATUS}.
35 */
36 public enum CacheResponseStatus {
37
38 /** The response was generated directly by the caching module. */
39 CACHE_MODULE_RESPONSE,
40
41 /** A response was generated from the cache with no requests sent
42 * upstream.
43 */
44 CACHE_HIT,
45
46 /** The response came from an upstream server. */
47 CACHE_MISS,
48
49 /** The response was generated from the cache after validating the
50 * entry with the origin server.
51 */
52 VALIDATED,
53
54 /** The response came from an upstream server after a cache failure */
55 FAILURE
56
57 }