public class

HttpCacheEntry

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.http.client.cache.HttpCacheEntry

Class Overview

Structure used to store an HttpResponse in a cache. Some entries can optionally depend on system resources that may require explicit deallocation. In such a case getResource() should return a non null instance of Resource that must be deallocated by calling dispose() method when no longer used.

Summary

Public Constructors
HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource, Map<String, String> variantMap)
Create a new HttpCacheEntry with variants.
HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource)
Create a new HttpCacheEntry.
Public Methods
Header[] getAllHeaders()
Returns all the headers that were on the origin response.
Header getFirstHeader(String name)
Returns the first header from the origin response with the given name.
Header[] getHeaders(String name)
Gets all the headers with the given name that were on the origin response.
ProtocolVersion getProtocolVersion()
Returns the ProtocolVersion from the origin HttpResponse.
String getReasonPhrase()
Gets the reason phrase from the origin HttpResponse, for example, "Not Modified".
Date getRequestDate()
Returns the time the associated origin request was initiated by the caching module.
Resource getResource()
Returns the Resource containing the origin response body.
Date getResponseDate()
Returns the time the origin response was received by the caching module.
int getStatusCode()
Returns the HTTP response code from the origin HttpResponse.
StatusLine getStatusLine()
Returns the StatusLine from the origin HttpResponse.
Map<String, String> getVariantMap()
Returns an index about where in the cache different variants for a given resource are stored.
boolean hasVariants()
Indicates whether the origin response indicated the associated resource had variants (i.e.
String toString()
Provides a string representation of this instance suitable for human consumption.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public HttpCacheEntry (Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource, Map<String, String> variantMap)

Create a new HttpCacheEntry with variants.

Parameters
requestDate Date/time when the request was made (Used for age calculations)
responseDate Date/time that the response came back (Used for age calculations)
statusLine HTTP status line from origin response
responseHeaders Header[] from original HTTP Response
resource representing origin response body
variantMap describing cache entries that are variants of this parent entry; this maps a "variant key" (derived from the varying request headers) to a "cache key" (where in the cache storage the particular variant is located)

public HttpCacheEntry (Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource)

Create a new HttpCacheEntry.

Parameters
requestDate Date/time when the request was made (Used for age calculations)
responseDate Date/time that the response came back (Used for age calculations)
statusLine HTTP status line from origin response
responseHeaders Header[] from original HTTP Response
resource representing origin response body

Public Methods

public Header[] getAllHeaders ()

Returns all the headers that were on the origin response.

public Header getFirstHeader (String name)

Returns the first header from the origin response with the given name.

public Header[] getHeaders (String name)

Gets all the headers with the given name that were on the origin response.

public ProtocolVersion getProtocolVersion ()

Returns the ProtocolVersion from the origin HttpResponse.

public String getReasonPhrase ()

Gets the reason phrase from the origin HttpResponse, for example, "Not Modified".

public Date getRequestDate ()

Returns the time the associated origin request was initiated by the caching module.

Returns

public Resource getResource ()

Returns the Resource containing the origin response body.

public Date getResponseDate ()

Returns the time the origin response was received by the caching module.

Returns

public int getStatusCode ()

Returns the HTTP response code from the origin HttpResponse.

public StatusLine getStatusLine ()

Returns the StatusLine from the origin HttpResponse.

public Map<String, String> getVariantMap ()

Returns an index about where in the cache different variants for a given resource are stored. This maps "variant keys" to "cache keys", where the variant key is derived from the varying request headers, and the cache key is the location in the HttpCacheStorage where that particular variant is stored. The first variant returned is used as the "parent" entry to hold this index of the other variants.

public boolean hasVariants ()

Indicates whether the origin response indicated the associated resource had variants (i.e. that the Vary header was set on the origin response).

Returns
  • true if this cached response was a variant

public String toString ()

Provides a string representation of this instance suitable for human consumption.