cz.jirutka.spring.http.client.cache

Class DefaultCachingPolicy

java.lang.Object

cz.jirutka.spring.http.client.cache.DefaultCachingPolicy

All Implemented Interfaces:

CachingPolicy

@Immutable
public class DefaultCachingPolicy
extends Object
implements CachingPolicy

Policy that determines if a request can be served from cache or a response can be cached.

This implementation currently supports HTTP/1.1 Cache-Control header only, no Expires etc.

Constructor Summary

Constructors

Constructor and Description
DefaultCachingPolicy(boolean sharedCache) Creates a new instance of DefaultCachingPolicy without the size limit.
DefaultCachingPolicy(boolean sharedCache, long maxBodySizeBytes) Creates a new instance of DefaultCachingPolicy with defined size limit of responses that should be stored in the cache.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isCacheableMethod(org.springframework.http.HttpMethod method)
protected boolean	isExplicitlyCacheable(org.springframework.http.client.ClientHttpResponse response) Whether the given response should be cached.
protected boolean	isExplicitlyNonCacheable(org.springframework.http.client.ClientHttpResponse response) Whether the given response must not be cached.
protected boolean	isImplicitlyCacheableStatus(int status) Whether the given status code can be cached implicitly, i.e.
protected boolean	isResponseCacheable(org.springframework.http.client.ClientHttpResponse response)
boolean	isResponseCacheable(org.springframework.http.HttpRequest request, org.springframework.http.client.ClientHttpResponse response) Determine if the ClientHttpResponse gotten from the origin is a cacheable response.
boolean	isServableFromCache(org.springframework.http.HttpRequest request) Determines if the given HttpRequest is allowed to be served from cache.
protected boolean	isUncacheableStatus(int status) Whether the given status code must not be cached, even when any cache header is specified.
protected boolean	isUnknownStatus(int status) Whether the given status code is considered to unknown and thus must not be cached.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCachingPolicy

public DefaultCachingPolicy(boolean sharedCache)

Creates a new instance of DefaultCachingPolicy without the size limit.

Parameters:

sharedCache - Whether to behave as a shared cache (true) or a non-shared/private cache (false).

See Also:

DefaultCachingPolicy(boolean, long)

DefaultCachingPolicy

public DefaultCachingPolicy(boolean sharedCache,
                    long maxBodySizeBytes)

Creates a new instance of DefaultCachingPolicy with defined size limit of responses that should be stored in the cache.

A private cache will not, for example, cache responses to requests with Authorization headers or responses marked with Cache-Control: private. If, however, the cache is only going to be used by one logical "user" (behaving similarly to a browser cache), then you will want to turn off the shared cache setting.

Parameters:

maxBodySizeBytes - The maximum content length.

sharedCache - Whether to behave as a shared cache (true) or a non-shared/private cache (false).

Method Detail

isResponseCacheable

public boolean isResponseCacheable(org.springframework.http.HttpRequest request,
                          org.springframework.http.client.ClientHttpResponse response)

Description copied from interface: CachingPolicy

Determine if the ClientHttpResponse gotten from the origin is a cacheable response.

Specified by:

isResponseCacheable in interface CachingPolicy

Parameters:

request - The request that generated an origin hit.

response - The response from the origin.

Returns:

true if response is cacheable.

isServableFromCache

public boolean isServableFromCache(org.springframework.http.HttpRequest request)

Description copied from interface: CachingPolicy

Determines if the given HttpRequest is allowed to be served from cache.

Specified by:

isServableFromCache in interface CachingPolicy

Parameters:

request - The request to check.

Returns:

true if request can be served from cache.

isResponseCacheable

protected boolean isResponseCacheable(org.springframework.http.client.ClientHttpResponse response)

isImplicitlyCacheableStatus

protected boolean isImplicitlyCacheableStatus(int status)

Whether the given status code can be cached implicitly, i.e. even when no cache header is specified.

Parameters:

status - HTTP status code

isUncacheableStatus

protected boolean isUncacheableStatus(int status)

Whether the given status code must not be cached, even when any cache header is specified.

Parameters:

status - HTTP status code

isUnknownStatus

protected boolean isUnknownStatus(int status)

Whether the given status code is considered to unknown and thus must not be cached. The unknown statuses list is based on Apache HTTP Components.

Parameters:

status - HTTP status code

isCacheableMethod

protected boolean isCacheableMethod(org.springframework.http.HttpMethod method)

isExplicitlyNonCacheable

protected boolean isExplicitlyNonCacheable(org.springframework.http.client.ClientHttpResponse response)

Whether the given response must not be cached.

isExplicitlyCacheable

protected boolean isExplicitlyCacheable(org.springframework.http.client.ClientHttpResponse response)

Whether the given response should be cached.