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 java.io.IOException;
30 import java.io.InputStream;
31 import java.io.Serializable;
32
33 /**
34 * Represents a disposable system resource used for handling
35 * cached response bodies.
36 *
37 * @since 4.1
38 */
39 public interface Resource extends Serializable {
40
41 /**
42 * Returns an {@link InputStream} from which the response
43 * body can be read.
44 * @throws IOException
45 */
46 InputStream getInputStream() throws IOException;
47
48 /**
49 * Returns the length in bytes of the response body.
50 */
51 long length();
52
53 /**
54 * Indicates the system no longer needs to keep this
55 * response body and any system resources associated with
56 * it may be reclaimed.
57 */
58 void dispose();
59
60 }