Showing the changes to java/pkg/java/net/CacheRequest.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,63 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2003, 2004, Oracle and/or its affiliates. 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. Oracle designates this | |
| 8 | + * particular file as subject to the "Classpath" exception as provided | |
| 9 | + * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 | + * or visit www.oracle.com if you need additional information or have any | |
| 23 | + * questions. | |
| 24 | + */ | |
| 25 | + | |
| 26 | +package java.net; | |
| 27 | + | |
| 28 | +import java.io.OutputStream; | |
| 29 | +import java.io.IOException; | |
| 30 | + | |
| 31 | +/** | |
| 32 | + * Represents channels for storing resources in the | |
| 33 | + * ResponseCache. Instances of such a class provide an | |
| 34 | + * OutputStream object which is called by protocol handlers to | |
| 35 | + * store the resource data into the cache, and also an abort() method | |
| 36 | + * which allows a cache store operation to be interrupted and | |
| 37 | + * abandoned. If an IOException is encountered while reading the | |
| 38 | + * response or writing to the cache, the current cache store operation | |
| 39 | + * will be aborted. | |
| 40 | + * | |
| 41 | + * @author Yingxian Wang | |
| 42 | + * @since 1.5 | |
| 43 | + */ | |
| 44 | +public abstract class CacheRequest { | |
| 45 | + | |
| 46 | + /** | |
| 47 | + * Returns an OutputStream to which the response body can be | |
| 48 | + * written. | |
| 49 | + * | |
| 50 | + * @return an OutputStream to which the response body can | |
| 51 | + * be written | |
| 52 | + * @throws IOException if an I/O error occurs while | |
| 53 | + * writing the response body | |
| 54 | + */ | |
| 55 | + public abstract OutputStream getBody() throws IOException; | |
| 56 | + | |
| 57 | + /** | |
| 58 | + * Aborts the attempt to cache the response. If an IOException is | |
| 59 | + * encountered while reading the response or writing to the cache, | |
| 60 | + * the current cache store operation will be abandoned. | |
| 61 | + */ | |
| 62 | + public abstract void abort(); | |
| 63 | +} | |