CacheRequest

AI-generated Key Takeaways

• CacheRequest objects manage the storage of resources in a ResponseCache.

• Provides an OutputStream to write response data into the cache.

• Includes an abort() method to interrupt and cancel caching operations.

• If an IOException occurs during read/write, the caching is automatically aborted.

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.

Public Constructor Summary

CacheRequest()

Public Method Summary

abstract void	abort() Aborts the attempt to cache the response.
abstract OutputStream	getBody() Returns an OutputStream to which the response body can be written.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public CacheRequest ()

Public Methods

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.

public abstract OutputStream getBody ()

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