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 ch.boye.httpclientandroidlib.client.cache; 28 29 import java.io.IOException; 30 import java.io.InputStream; 31 32 /** 33 * Generates {@link Resource} instances for handling cached 34 * HTTP response bodies. 35 * 36 * @since 4.1 37 */ 38 public interface ResourceFactory { 39 40 /** 41 * Creates a {@link Resource} from a given response body. 42 * @param requestId a unique identifier for this particular 43 * response body 44 * @param instream the original {@link InputStream} 45 * containing the response body of the origin HTTP response. 46 * @param limit maximum number of bytes to consume of the 47 * response body; if this limit is reached before the 48 * response body is fully consumed, mark the limit has 49 * having been reached and return a {@code Resource} 50 * containing the data read to that point. 51 * @return a {@code Resource} containing however much of 52 * the response body was successfully read. 53 * @throws IOException 54 */ generate(String requestId, InputStream instream, InputLimit limit)55 Resource generate(String requestId, InputStream instream, InputLimit limit) throws IOException; 56 57 /** 58 * Clones an existing {@link Resource}. 59 * @param requestId unique identifier provided to associate 60 * with the cloned response body. 61 * @param resource the original response body to clone. 62 * @return the {@code Resource} copy 63 * @throws IOException 64 */ copy(String requestId, Resource resource)65 Resource copy(String requestId, Resource resource) throws IOException; 66 67 } 68