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.io.ByteArrayInputStream;
30 import java.io.InputStream;
31 import java.io.Serializable;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35
36 /**
37 * Represents a disposable system resource used for handling
38 * cached response bodies.
39 * <p>
40 * Implementations of this interface are expected to be threading-safe.
41 * </p>
42 *
43 * @since 4.1
44 */
45 @Contract(threading = ThreadingBehavior.SAFE)
46 public abstract class Resource implements Serializable {
47
48 private static final long serialVersionUID = 1L;
49
50 /**
51 * Returns resource content as a {@link InputStream}.
52 *
53 * @throws ResourceIOException
54 */
55 public InputStream getInputStream() throws ResourceIOException {
56 return new ByteArrayInputStream(get());
57 }
58
59 /**
60 * Returns resource content as a byte array.
61 * <p>
62 * Please note for memory efficiency some resource implementations
63 * may return a reference to the underlying byte array. The returned
64 * value should be treated as immutable.
65 *
66 * @throws ResourceIOException
67 *
68 * @since 5.0
69 */
70 public abstract byte[] get() throws ResourceIOException;
71
72 /**
73 * Returns the length in bytes of the response body.
74 */
75 public abstract long length();
76
77 /**
78 * Indicates the system no longer needs to keep this
79 * response body and any system resources associated with
80 * it may be reclaimed.
81 */
82 public abstract void dispose();
83
84 }