/*
* Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.net;
import java.io.OutputStream;
import java.io.IOException;
Represents channels for storing resources in the
ResponseCache. Instances of such a class provide an
OutputStream object which is called by protocol handlers to
store the resource data into the cache, and also an abort() method
which allows a cache store operation to be interrupted and
abandoned. If an IOException is encountered while reading the
response or writing to the cache, the current cache store operation
will be aborted.
Author: Yingxian Wang Since: 1.5
/**
* Represents channels for storing resources in the
* ResponseCache. Instances of such a class provide an
* OutputStream object which is called by protocol handlers to
* store the resource data into the cache, and also an abort() method
* which allows a cache store operation to be interrupted and
* abandoned. If an IOException is encountered while reading the
* response or writing to the cache, the current cache store operation
* will be aborted.
*
* @author Yingxian Wang
* @since 1.5
*/
public abstract class CacheRequest {
Returns an OutputStream to which the response body can be
written.
Throws: - IOException – if an I/O error occurs while
writing the response body
Returns: an OutputStream to which the response body can
be written
/**
* Returns an OutputStream to which the response body can be
* written.
*
* @return an OutputStream to which the response body can
* be written
* @throws IOException if an I/O error occurs while
* writing the response body
*/
public abstract OutputStream getBody() throws IOException;
Aborts the attempt to cache the response. If an IOException is
encountered while reading the response or writing to the cache,
the current cache store operation will be abandoned.
/**
* Aborts the attempt to cache the response. If an IOException is
* encountered while reading the response or writing to the cache,
* the current cache store operation will be abandoned.
*/
public abstract void abort();
}