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 java.net.URI; 30 31 import org.apache.hc.core5.annotation.Contract; 32 import org.apache.hc.core5.annotation.Internal; 33 import org.apache.hc.core5.annotation.ThreadingBehavior; 34 import org.apache.hc.core5.function.Resolver; 35 import org.apache.hc.core5.http.HttpHost; 36 import org.apache.hc.core5.http.HttpRequest; 37 import org.apache.hc.core5.http.HttpResponse; 38 39 /** 40 * Given a particular HTTP request / response pair, flush any cache entries 41 * that this exchange would invalidate. 42 * 43 * @since 4.3 44 */ 45 @Contract(threading = ThreadingBehavior.STATELESS) 46 @Internal 47 public interface HttpCacheInvalidator { 48 49 /** 50 * Flush {@link HttpCacheEntry}s invalidated by the given request. 51 * 52 * @param host backend host 53 * @param request request message 54 * @param cacheKeyResolver cache key resolver used by cache storage 55 * @param cacheStorage internal cache storage 56 * 57 * @since 5.0 58 */ 59 void flushCacheEntriesInvalidatedByRequest( 60 HttpHost host, 61 HttpRequest request, 62 Resolver<URI, String> cacheKeyResolver, 63 HttpCacheStorage cacheStorage); 64 65 /** 66 * Flush {@link HttpCacheEntry}s invalidated by the given message exchange. 67 * 68 * @param host backend host 69 * @param request request message 70 * @param response response message 71 * @param cacheKeyResolver cache key resolver used by cache storage 72 * @param cacheStorage internal cache storage 73 * 74 * @since 5.0 75 */ 76 void flushCacheEntriesInvalidatedByExchange( 77 HttpHost host, 78 HttpRequest request, 79 HttpResponse response, 80 Resolver<URI, String> cacheKeyResolver, 81 HttpCacheStorage cacheStorage); 82 83 }