Class CacheRequest

java.lang.Object
- java.net.CacheRequest

public abstract class CacheRequest
extends Object

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.

Since:: 1.5

Constructor Summary

Constructors
Constructor	Description
`CacheRequest()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract void`	`abort()`	Aborts the attempt to cache the response.
`abstract OutputStream`	`getBody()`	Returns an OutputStream to which the response body can be written.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheRequest

public CacheRequest()

Method Detail

getBody

public abstract OutputStream getBody()
                              throws IOException

Returns an OutputStream to which the response body can be written.

Returns:: an OutputStream to which the response body can be written
Throws:: IOException - if an I/O error occurs while writing the response body

abort

public abstract void abort()

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.