com.bazaarvoice.dropwizard.caching

Class RequestCacheControl

java.lang.Object

com.bazaarvoice.dropwizard.caching.RequestCacheControl

public class RequestCacheControl
extends Object

Cache-Control header options that are valid for an HTTP request.

For more info, see RFC 2616, Section 14.9. Also, RFC 2616, Section 14.9.4 applies to request cache control options.

Field Summary

Fields

Modifier and Type	Field and Description
static RequestCacheControl	DEFAULT

Constructor Summary

Constructors

Constructor and Description
RequestCacheControl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,com.google.common.base.Optional<String>>	getCacheExtension() Unknown or unsupported cache control directives.
int	getMaxAge() Indicates that the client is willing to accept a response whose age is no greater than the specified time in seconds.
int	getMaxStale() Indicates that the client is willing to accept a response that has exceeded its expiration time.
int	getMinFresh() Indicates that the client is willing to accept a response whose freshness lifetime is no less than its current age plus the specified time in seconds.
int	hashCode()
boolean	isNoCache() If true, the server MUST NOT use a cached copy when responding to the request.
boolean	isNoStore() If true, a cache MUST NOT store any part of either this request or any response to it.
boolean	isNoTransform() If true, an intermediate cache or proxy MUST NOT change those headers that are listed in section 13.5.2 as being subject to the no-transform directive.
boolean	isOnlyIfCached() If true, a cache SHOULD either respond using a cached entry that is consistent with the other constraints of the request, or respond with a 504 (Gateway Timeout) status.
String	toString()
static RequestCacheControl	valueOf(String value) Creates a new instance of public class RequestCacheControl by parsing the supplied string.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final RequestCacheControl DEFAULT

Constructor Detail

RequestCacheControl

public RequestCacheControl()

Method Detail

valueOf

public static RequestCacheControl valueOf(String value)

Creates a new instance of public class RequestCacheControl by parsing the supplied string.

Parameters:

value - the cache control string

Returns:

the newly created RequestCacheControl

Throws:

IllegalArgumentException - if the supplied string cannot be parsed

isNoCache

public boolean isNoCache()

If true, the server MUST NOT use a cached copy when responding to the request.

Returns:

true to force a fresh request

isNoStore

public boolean isNoStore()

If true, a cache MUST NOT store any part of either this request or any response to it.

Returns:

true to force the response to not be cached

getMaxAge

public int getMaxAge()

Indicates that the client is willing to accept a response whose age is no greater than the specified time in seconds.

Unless getMaxStale() directive is also included, the client is not willing to accept a stale response.

Returns:

max age, in seconds, or -1 if the max-age option was not set

getMaxStale

public int getMaxStale()

Indicates that the client is willing to accept a response that has exceeded its expiration time.

If max-stale is assigned a value, then the client is willing to accept a response that has exceeded its expiration time by no more than the specified number of seconds. If Integer.MAX_VALUE is assigned to max-stale, then the client is willing to accept a stale response of any age.

Returns:

max response staleness, in seconds, or -1 if the max-stale option was not set

getMinFresh

public int getMinFresh()

Indicates that the client is willing to accept a response whose freshness lifetime is no less than its current age plus the specified time in seconds. That is, the client wants a response that will still be fresh for at least the specified number of seconds.

Returns:

min freshness, in seconds, or -1 if the min-fresh option was not set

isNoTransform

public boolean isNoTransform()

If true, an intermediate cache or proxy MUST NOT change those headers that are listed in section 13.5.2 as being subject to the no-transform directive. This implies that the cache or proxy MUST NOT change any aspect of the entity-body that is specified by these headers, including the value of the entity-body itself.

Returns:

true if the cache/proxy must not modify the response

isOnlyIfCached

public boolean isOnlyIfCached()

If true, a cache SHOULD either respond using a cached entry that is consistent with the other constraints of the request, or respond with a 504 (Gateway Timeout) status.

If a group of caches is being operated as a unified system with good internal connectivity, such a request MAY be forwarded within that group of caches.

Returns:

true to only serve the response from a cache

getCacheExtension

public Map<String,com.google.common.base.Optional<String>> getCacheExtension()

Unknown or unsupported cache control directives.

If the directive appeared as a bare value, the value in the map will be absent. The keys are lowercase. These directives can be ignored by an intermediate cache/proxy, but they must be passed to any upstream caches.

Returns:

immutable map from directive name to value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object