1 /*
2 * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.net;
27
28 import java.io.InputStream;
29 import java.util.Map;
30 import java.util.List;
31 import java.io.IOException;
32
33 /**
34 * Represent channels for retrieving resources from the
35 * ResponseCache. Instances of such a class provide an
36 * InputStream that returns the entity body, and also a
37 * getHeaders() method which returns the associated response headers.
38 *
39 * @author Yingxian Wang
40 * @since 1.5
41 */
42 public abstract class CacheResponse {
43
44 /**
45 * Returns the response headers as a Map.
46 *
47 * @return An immutable Map from response header field names to
48 * lists of field values. The status line has null as its
49 * field name.
50 * @throws IOException if an I/O error occurs
51 * while getting the response headers
52 */
53 public abstract Map<String, List<String>> getHeaders() throws IOException;
54
55 /**
56 * Returns the response body as an InputStream.
57 *
58 * @return an InputStream from which the response body can
59 * be accessed
60 * @throws IOException if an I/O error occurs while
61 * getting the response body
62 */
63 public abstract InputStream getBody() throws IOException;
64 }