OpenJDK 27 · java.net.ResponseCache · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static ResponseCache	theResponseCache The system wide cache that provides access to a url caching mechanism.

Access	Constructor and Description
public	ResponseCache() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public abstract CacheResponse	Returns: a `CacheResponse` instance if available from cache, or null otherwise get(URI a `URI` used to reference the requested network resource uri, String a `String` representing the request method rqstMethod, Map<String, List<String>> a Map from request header field names to lists of field values representing the current request headers rqstHeaders) Retrieve the cached response based on the requesting uri, request method and request headers.
public static synchronized ResponseCache	Returns: the system-wide `ResponseCache` getDefault() Gets the system-wide response cache.
public abstract CacheRequest	Returns: a `CacheRequest` for recording the response to be cached. Null return indicates that the caller does not intend to cache the response. put(URI a `URI` used to reference the requested network resource uri, URLConnection a URLConnection instance that is used to fetch the response to be cached 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.
public static synchronized void	setDefault(ResponseCache The response cache, or `null` to unset the cache. responseCache) Sets (or unsets) the system-wide cache.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

theResponseCache	back to summary
private static ResponseCache theResponseCache The system wide cache that provides access to a url caching mechanism. See Also `setDefault(ResponseCache)`, `getDefault()`

ResponseCache	back to summary
public ResponseCache() Constructor for subclasses to call.

Method Detail

get back to summary

get	back to summary
public abstract CacheResponse get(URI uri, String rqstMethod, Map<String, List<String>> rqstHeaders) throws IOException 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<String, List<String>> 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 Exceptions IOException: if an I/O error occurs IllegalArgumentException: if any one of the arguments is null See Also `java.net.URLConnection#setUseCaches(boolean)`, `java.net.URLConnection#getUseCaches()`, `java.net.URLConnection#setDefaultUseCaches(boolean)`, `java.net.URLConnection#getDefaultUseCaches()`

public abstract CacheResponse get(URI uri, String rqstMethod, Map<String, List<String>> rqstHeaders) throws IOException

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<String, List<String>>: 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

Exceptions

IOException:: if an I/O error occurs
IllegalArgumentException:: if any one of the arguments is null

getDefault back to summary

getDefault	back to summary
public static synchronized ResponseCache getDefault() Gets the system-wide response cache. Returns:ResponseCache the system-wide `ResponseCache` Since 1.5 See Also `setDefault(ResponseCache)`

public static synchronized ResponseCache getDefault()

Gets the system-wide response cache.

Returns:ResponseCache: the system-wide ResponseCache
Since: 1.5
See Also: setDefault(ResponseCache)

put back to summary

put	back to summary
public abstract CacheRequest put(URI uri, URLConnection conn) throws IOException 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. Exceptions IOException: if an I/O error occurs IllegalArgumentException: if any one of the arguments is null

public abstract CacheRequest put(URI uri, URLConnection conn) throws IOException

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.

Exceptions

IOException:: if an I/O error occurs
IllegalArgumentException:: if any one of the arguments is null

setDefault back to summary

setDefault	back to summary
public static synchronized void setDefault(ResponseCache responseCache) Sets (or unsets) the system-wide cache. Note non-standard protocol handlers may ignore this setting. Parameters responseCache:ResponseCache The response cache, or `null` to unset the cache. Since 1.5 See Also `getDefault()`

public static synchronized void setDefault(ResponseCache responseCache)

Sets (or unsets) the system-wide cache.

Note

non-standard protocol handlers may ignore this setting.

Parameters

responseCache:ResponseCache: The response cache, or null to unset the cache.

Since

1.5

See Also

getDefault()

public abstract Class ResponseCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail