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