com.bazaarvoice.dropwizard.caching

Class CacheResponseContext

java.lang.Object

com.bazaarvoice.dropwizard.caching.CacheResponseContext

public class CacheResponseContext
extends Object

Cache related context information for a response.

Constructor Summary

Constructors

Constructor and Description
CacheResponseContext(com.sun.jersey.api.core.HttpResponseContext httpContext)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.CacheControl	getCacheControl() Get the cache control options specified in the response.
com.google.common.base.Optional<org.joda.time.DateTime>	getDate() Get the HttpHeaders.DATE HTTP header.
com.sun.jersey.api.core.HttpResponseContext	getHttpContext()
int	getSharedCacheMaxAge() Get the max time, in seconds, the response should be served from a shared cache or -1 if no max age has been set.
int	getStatusCode() Get the HTTP response status code (e.g.
void	setAge(org.joda.time.DateTime start, org.joda.time.DateTime end) Set the HttpHeaders.AGE HTTP header as the difference between two instants (end - start).
void	setAge(int seconds) Set the HttpHeaders.AGE HTTP header.
void	setDate(org.joda.time.DateTime date) Set the HttpHeaders.DATE HTTP header.
void	setExpires(org.joda.time.DateTime date) Set the HttpHeaders.EXPIRES HTTP header.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheResponseContext

public CacheResponseContext(com.sun.jersey.api.core.HttpResponseContext httpContext)

Method Detail

getHttpContext

public com.sun.jersey.api.core.HttpResponseContext getHttpContext()

getStatusCode

public int getStatusCode()

Get the HTTP response status code (e.g. 200, 404, 503, etc).

Returns:

status code

getCacheControl

public javax.ws.rs.core.CacheControl getCacheControl()

Get the cache control options specified in the response.

Although CacheControl is mutable, the returned value should be treated as immutable.

Returns:

response cache control options

getSharedCacheMaxAge

public int getSharedCacheMaxAge()

Get the max time, in seconds, the response should be served from a shared cache or -1 if no max age has been set.

Returns:

response shared cache max age, in seconds, or -1

getDate

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

Get the HttpHeaders.DATE HTTP header.

Returns:

date header value or absent if the header is not set or the value is invalid

setDate

public void setDate(org.joda.time.DateTime date)

Set the HttpHeaders.DATE HTTP header.

Parameters:

date - instant to set the date header to

setExpires

public void setExpires(org.joda.time.DateTime date)

Set the HttpHeaders.EXPIRES HTTP header.

Parameters:

date - instant to set the expires header to

setAge

public void setAge(org.joda.time.DateTime start,
          org.joda.time.DateTime end)

Set the HttpHeaders.AGE HTTP header as the difference between two instants (end - start).

Sets the age to 0 if end < start.

Parameters:

start - starting instant

end - ending instant

setAge

public void setAge(int seconds)

Set the HttpHeaders.AGE HTTP header.

Parameters:

seconds - number of seconds to set the header to (>= 0)