com.bazaarvoice.dropwizard.caching

Class CachedResponse

java.lang.Object

com.bazaarvoice.dropwizard.caching.CachedResponse

public class CachedResponse
extends Object

Response loaded from the cache.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	NON_CACHEABLE_HEADERS Names of HTTP headers that are automatically excluded from the cached response headers.

Constructor Summary

Constructors

Constructor and Description
CachedResponse(int statusCode, javax.ws.rs.core.MultivaluedMap<String,String> headers, byte[] content)

Method Summary

Methods

Modifier and Type	Method and Description
static CachedResponse	build(int statusCode, javax.ws.rs.core.MultivaluedMap<String,Object> headers, byte[] content)
boolean	equals(Object obj)
com.google.common.base.Optional<javax.ws.rs.core.CacheControl>	getCacheControl() Get the HttpHeaders.CACHE_CONTROL header, if set.
org.joda.time.DateTime	getDate() Get the date the response was generated.
com.google.common.base.Optional<org.joda.time.DateTime>	getExpires()
byte[]	getResponseContent()
javax.ws.rs.core.MultivaluedMap<String,String>	getResponseHeaders() Immutable map from response header name (case insensitive) to list of header values.
int	getStatusCode()
boolean	hasExpiration() True if this response has a configured expiration time.
int	hashCode()
boolean	isExpired(org.joda.time.DateTime now) True if the response has an expiration time and that expiration is after the provided instant.
javax.ws.rs.core.Response.ResponseBuilder	response(org.joda.time.DateTime now)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NON_CACHEABLE_HEADERS

public static final Set<String> NON_CACHEABLE_HEADERS

Names of HTTP headers that are automatically excluded from the cached response headers. The set implementation is case-insensitive.

Age is non-cacheable because it must be recalculated each time the response is returned.

Constructor Detail

CachedResponse

public CachedResponse(int statusCode,
              javax.ws.rs.core.MultivaluedMap<String,String> headers,
              byte[] content)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

build

public static CachedResponse build(int statusCode,
                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                   byte[] content)

response

public javax.ws.rs.core.Response.ResponseBuilder response(org.joda.time.DateTime now)

hasExpiration

public boolean hasExpiration()

True if this response has a configured expiration time.

isExpired

public boolean isExpired(org.joda.time.DateTime now)

True if the response has an expiration time and that expiration is after the provided instant.

getDate

public org.joda.time.DateTime getDate()

Get the date the response was generated.

Retrieves the HttpHeaders.DATE header or current time if no date header is found.

Returns:

response date

getCacheControl

public com.google.common.base.Optional<javax.ws.rs.core.CacheControl> getCacheControl()

Get the HttpHeaders.CACHE_CONTROL header, if set.

Returns:

cache-control header or absent if cache-control header is not set

getExpires

public com.google.common.base.Optional<org.joda.time.DateTime> getExpires()

getResponseContent

public byte[] getResponseContent()

getResponseHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getResponseHeaders()

Immutable map from response header name (case insensitive) to list of header values.

Returns:

response headers

getStatusCode

public int getStatusCode()