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.HttpHost;
30  import org.apache.http.HttpRequest;
31  import org.apache.http.HttpResponse;
32  
33  /**
34   * Given a particular HttpRequest, flush any cache entries that this request
35   * would invalidate.
36   *
37   * @since 4.3
38   */
39  public interface HttpCacheInvalidator {
40  
41      /**
42       * Remove cache entries from the cache that are no longer fresh or have been
43       * invalidated in some way.
44       *
45       * @param host
46       *            The backend host we are talking to
47       * @param req
48       *            The HttpRequest to that host
49       */
50      void flushInvalidatedCacheEntries(HttpHost host, HttpRequest req);
51  
52      /**
53       * Flushes entries that were invalidated by the given response received for
54       * the given host/request pair.
55       */
56      void flushInvalidatedCacheEntries(HttpHost host, HttpRequest request, HttpResponse response);
57  
58  }