CacheRequest
Stay organized with collections
Save and categorize content based on your preferences.
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
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 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
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eCacheRequest\u003c/code\u003e objects manage the storage of resources in a ResponseCache.\u003c/p\u003e\n"],["\u003cp\u003eProvides an \u003ccode\u003eOutputStream\u003c/code\u003e to write response data into the cache.\u003c/p\u003e\n"],["\u003cp\u003eIncludes an \u003ccode\u003eabort()\u003c/code\u003e method to interrupt and cancel caching operations.\u003c/p\u003e\n"],["\u003cp\u003eIf an \u003ccode\u003eIOException\u003c/code\u003e occurs during read/write, the caching is automatically aborted.\u003c/p\u003e\n"]]],[],null,["# CacheRequest\n\npublic abstract class **CacheRequest** extends [Object](../../../reference/java/lang/Object.html) \nRepresents channels for storing resources in the\nResponseCache. Instances of such a class provide an\nOutputStream object which is called by protocol handlers to\nstore the resource data into the cache, and also an abort() method\nwhich allows a cache store operation to be interrupted and\nabandoned. If an IOException is encountered while reading the\nresponse or writing to the cache, the current cache store operation\nwill be aborted. \n\n### Public Constructor Summary\n\n|---|--------------------------------------------------------------------------------|\n| | [CacheRequest](../../../reference/java/net/CacheRequest.html#CacheRequest())() |\n\n### Public Method Summary\n\n|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| abstract void | [abort](../../../reference/java/net/CacheRequest.html#abort())() Aborts the attempt to cache the response. |\n| abstract [OutputStream](../../../reference/java/io/OutputStream.html) | [getBody](../../../reference/java/net/CacheRequest.html#getBody())() Returns an OutputStream to which the response body can be written. |\n\n### Inherited Method Summary\n\nFrom class [java.lang.Object](../../../reference/java/lang/Object.html) \n\n|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Object](../../../reference/java/lang/Object.html) | [clone](../../../reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |\n| boolean | [equals](../../../reference/java/lang/Object.html#equals(java.lang.Object))([Object](../../../reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |\n| void | [finalize](../../../reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |\n| final [Class](../../../reference/java/lang/Class.html)\\\u003c?\\\u003e | [getClass](../../../reference/java/lang/Object.html#getClass())() Returns the unique instance of [Class](../../../reference/java/lang/Class.html) that represents this object's class. |\n| int | [hashCode](../../../reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |\n| final void | [notify](../../../reference/java/lang/Object.html#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. |\n| final void | [notifyAll](../../../reference/java/lang/Object.html#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. |\n| [String](../../../reference/java/lang/String.html) | [toString](../../../reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long,%20int))(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. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long))(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. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |\n\nPublic Constructors\n-------------------\n\n#### public\n**CacheRequest**\n()\n\n\u003cbr /\u003e\n\nPublic Methods\n--------------\n\n#### public abstract void\n**abort**\n()\n\nAborts the attempt to cache the response. If an IOException is\nencountered while reading the response or writing to the cache,\nthe current cache store operation will be abandoned. \n\n#### public abstract [OutputStream](../../../reference/java/io/OutputStream.html)\n**getBody**\n()\n\nReturns an OutputStream to which the response body can be\nwritten. \n\n##### Returns\n\n- an OutputStream to which the response body can be written \n\n##### Throws\n\n| [IOException](../../../reference/java/io/IOException.html) | if an I/O error occurs while writing the response body |\n|------------------------------------------------------------|--------------------------------------------------------|"]]