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 org.apache.hc.core5.annotation.Contract; 30 import org.apache.hc.core5.annotation.ThreadingBehavior; 31 32 /** 33 * Generates {@link Resource} instances for handling cached 34 * HTTP response bodies. 35 * 36 * @since 4.1 37 */ 38 @Contract(threading = ThreadingBehavior.STATELESS) 39 public interface ResourceFactory { 40 41 /** 42 * Creates a {@link Resource} from a given response body. 43 * @param requestId a unique identifier for this particular response body. 44 * @param content byte array that represents the origin HTTP response body. 45 * @return a {@code Resource} containing however much of 46 * the response body was successfully read. 47 * @throws ResourceIOException 48 */ 49 Resource generate(String requestId, byte[] content) throws ResourceIOException; 50 51 /** 52 * Creates a {@link Resource} from a given response body. 53 * @param requestId a unique identifier for this particular response body. 54 * @param content byte array that represents the origin HTTP response body. 55 * @param off the start offset in the array. 56 * @param len the number of bytes to read from the array. 57 * @return a {@code Resource} containing however much of 58 * the response body was successfully read. 59 * @throws ResourceIOException 60 */ 61 Resource generate(String requestId, byte[] content, int off, int len) throws ResourceIOException; 62 63 /** 64 * Clones an existing {@link Resource}. 65 * @param requestId unique identifier provided to associate 66 * with the cloned response body. 67 * @param resource the original response body to clone. 68 * @return the {@code Resource} copy 69 * @throws ResourceIOException 70 */ 71 Resource copy(String requestId, Resource resource) throws ResourceIOException; 72 73 }