to top
Android APIs
public abstract class

ResponseCache

extends Object
java.lang.Object
   ↳ java.net.ResponseCache
Known Direct Subclasses

Class Overview

Caches URLConnection responses.

The system's default cache can be set using setDefault(ResponseCache). If getUseCaches() returns true, URLConnection will use the default response cache, if one has been set.

Although URLConnection will always call put(URI, URLConnection), the specific ResponseCache implementation gets to decide what will actually be cached, and for how long.

Summary

Public Constructors
ResponseCache()
Public Methods
abstract CacheResponse get(URI uri, String requestMethod, Map<String, List<String>> requestHeaders)
Returns the cached response corresponding to the given request.
static ResponseCache getDefault()
Returns the system's default response cache, or null.
abstract CacheRequest put(URI uri, URLConnection connection)
Allows the protocol handler to cache data after retrieving resources.
static void setDefault(ResponseCache responseCache)
Sets the system's default response cache.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ResponseCache ()

Added in API level 1

Public Methods

public abstract CacheResponse get (URI uri, String requestMethod, Map<String, List<String>> requestHeaders)

Added in API level 1

Returns the cached response corresponding to the given request.

Parameters
uri the request URI.
requestMethod the request method.
requestHeaders a map of request headers.
Returns
  • the CacheResponse object if the request is available in the cache or null otherwise.
Throws
IOException if an I/O error occurs while getting the cached data.
IllegalArgumentException if any one of the parameters is set to null.

public static ResponseCache getDefault ()

Added in API level 1

Returns the system's default response cache, or null.

public abstract CacheRequest put (URI uri, URLConnection connection)

Added in API level 1

Allows the protocol handler to cache data after retrieving resources. The ResponseCache decides whether the resource data should be cached or not. If so, this method returns a CacheRequest to write the resource data to. Otherwise, this method returns null.

Parameters
uri the reference to the requested resource.
connection the connection to fetch the response.
Returns
  • a CacheRequest object with a WriteableByteChannel if the resource has to be cached, null otherwise.
Throws
IOException if an I/O error occurs while adding the resource.
IllegalArgumentException if any one of the parameters is set to null.

public static void setDefault (ResponseCache responseCache)

Added in API level 1

Sets the system's default response cache. Use null to remove the response cache.