Skip to content

Most visited

Recently visited

navigation
Added in API level 1

ResponseCache

public abstract class ResponseCache
extends Object

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


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:

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

Summary

Public constructors

ResponseCache()

Public methods

abstract CacheResponse get(URI uri, String rqstMethod, Map<StringList<String>> rqstHeaders)

Retrieve the cached response based on the requesting uri, request method and request headers.

static ResponseCache getDefault()

Gets the system-wide response cache.

abstract CacheRequest put(URI uri, URLConnection 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.

static void setDefault(ResponseCache responseCache)

Sets (or unsets) the system-wide cache.

Inherited methods

From class java.lang.Object

Public constructors

ResponseCache

Added in API level 1
ResponseCache ()

Public methods

get

Added in API level 1
CacheResponse get (URI uri, 
                String rqstMethod, 
                Map<StringList<String>> 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 URI: a URI used to reference the requested network resource
rqstMethod String: a String representing the request method
rqstHeaders Map: - a Map from request header field names to lists of field values representing the current request headers
Returns
CacheResponse a CacheResponse instance if available from cache, or null otherwise
Throws
IOException if an I/O error occurs
IllegalArgumentException if any one of the arguments is null

See also:

getDefault

Added in API level 1
ResponseCache getDefault ()

Gets the system-wide response cache.

Returns
ResponseCache the system-wide ResponseCache
Throws
SecurityException If a security manager has been installed and it denies NetPermission("getResponseCache")

See also:

put

Added in API level 1
CacheRequest put (URI uri, 
                URLConnection 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 URI: a URI used to reference the requested network resource
conn URLConnection: - a URLConnection instance that is used to fetch the response to be cached
Returns
CacheRequest a CacheRequest for recording the response to be cached. Null return indicates that the caller does not intend to cache the response.
Throws
IOException if an I/O error occurs
IllegalArgumentException if any one of the arguments is null

setDefault

Added in API level 1
void setDefault (ResponseCache responseCache)

Sets (or unsets) the system-wide cache. Note: non-standard procotol handlers may ignore this setting.

Parameters
responseCache ResponseCache: The response cache, or null to unset the cache.
Throws
SecurityException If a security manager has been installed and it denies NetPermission("setResponseCache")

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.