# ResponseCache

public abstract class **ResponseCache** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
Represents implementations of URLConnection caches. An instance of
such a class can be registered with the system by doing
ResponseCache.setDefault(ResponseCache), and the system will call
this object in order to:

- store resource data which has been retrieved from an external source into the cache
- try to fetch a requested resource that may have been stored in the cache

The ResponseCache implementation decides which resources should be cached, and for how long they should be cached. If a request resource cannot be retrieved from the cache, then the protocol handlers will fetch the resource from its original location. The settings for URLConnection#useCaches controls whether the protocol is allowed to use a cached response. For more information on HTTP caching, see [*RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1*](http://www.ietf.org/rfc/rfc2616.txt)

<br />

### Public Constructor Summary

|---|---|
|   | [ResponseCache](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#ResponseCache())() |

### Public Method Summary

|---|---|
| abstract [CacheResponse](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/CacheResponse.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#get(java.net.URI,%20java.lang.String,%20java.util.Map<java.lang.String,%20java.util.List<java.lang.String>>))([URI](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URI.html) uri, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) rqstMethod, [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\>\> rqstHeaders) Retrieve the cached response based on the requesting uri, request method and request headers. |
| synchronized static [ResponseCache](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html) | [getDefault](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#getDefault())() Gets the system-wide response cache. |
| abstract [CacheRequest](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/CacheRequest.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#put(java.net.URI,%20java.net.URLConnection))([URI](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URI.html) uri, [URLConnection](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html) conn) The protocol handler calls this method after a resource has been retrieved, and the ResponseCache must decide whether or not to store the resource in its cache. |
| synchronized static void | [setDefault](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#setDefault(java.net.ResponseCache))([ResponseCache](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html) responseCache) Sets (or unsets) the system-wide cache. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/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. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/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. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/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. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/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. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**ResponseCache**
()

<br />

## Public Methods

#### public abstract [CacheResponse](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/CacheResponse.html)
**get**
([URI](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URI.html) uri, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) rqstMethod, [Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\>\> rqstHeaders)

Retrieve the cached response based on the requesting uri,
request method and request headers. Typically this method is
called by the protocol handler before it sends out the request
to get the network resource. If a cached response is returned,
that resource is used instead.

##### Parameters

| uri | a `URI` used to reference the requested network resource |
| rqstMethod | a `String` representing the request method |
| rqstHeaders | - a Map from request header field names to lists of field values representing the current request headers |
|---|---|

##### Returns

- a `CacheResponse` instance if available from cache, or null otherwise

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if any one of the arguments is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html#setUseCaches(boolean)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html#getUseCaches()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html#setDefaultUseCaches(boolean)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html#getDefaultUseCaches()`

#### public static synchronized [ResponseCache](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html)
**getDefault**
()

Gets the system-wide response cache.

##### Returns

- the system-wide `ResponseCache`

##### Throws

| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | If a security manager has been installed and it denies `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/NetPermission.html``("getResponseCache")` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#setDefault(java.net.ResponseCache)`

#### public abstract [CacheRequest](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/CacheRequest.html)
**put**
([URI](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URI.html) uri, [URLConnection](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/URLConnection.html) conn)

The protocol handler calls this method after a resource has
been retrieved, and the ResponseCache must decide whether or
not to store the resource in its cache. If the resource is to
be cached, then put() must return a CacheRequest object which
contains an OutputStream that the protocol handler will
use to write the resource into the cache. If the resource is
not to be cached, then put must return null.

##### Parameters

| uri | a `URI` used to reference the requested network resource |
| conn | - a URLConnection instance that is used to fetch the response to be cached |
|---|---|

##### Returns

- a `CacheRequest` for recording the response to be cached. Null return indicates that the caller does not intend to cache the response.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if any one of the arguments is null |
|---|---|

#### public static synchronized void
**setDefault**
([ResponseCache](https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html) responseCache)

Sets (or unsets) the system-wide cache.

Note: non-standard procotol handlers may ignore this setting.

##### Parameters

| responseCache | The response cache, or `null` to unset the cache. |
|---|---|

##### Throws

| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | If a security manager has been installed and it denies `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/NetPermission.html``("setResponseCache")` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/net/ResponseCache.html#getDefault()`