org.spincast.core.exchange

Interface ICacheHeadersRequestContextAddon<R extends IRequestContext<?>>

All Known Implementing Classes:

SpincastCacheHeadersRequestContextAddon

public interface ICacheHeadersRequestContextAddon<R extends IRequestContext<?>>

Request context add-on to work with cache headers.

Method Summary

Modifier and Type	Method and Description
ICacheHeadersRequestContextAddon<R>	cache(int seconds) The number of seconds the client should cache this resource before requesting it again.
ICacheHeadersRequestContextAddon<R>	cache(int seconds, boolean isPrivate) The number of seconds the client should cache this resource before requesting it again.
ICacheHeadersRequestContextAddon<R>	cache(int seconds, boolean isPrivate, Integer secondsCdn) The number of seconds the client should cache this resource before requesting it again.
ICacheHeadersRequestContextAddon<R>	eTag(String currentTag) Specifies the current ETag (strong) of the resource.
ICacheHeadersRequestContextAddon<R>	eTag(String currentTag, boolean currentTagIsWeak) Specifies the current strong or weak ETag of the resource.
ICacheHeadersRequestContextAddon<R>	eTag(String currentTag, boolean currentTagIsWeak, boolean weakComparison) Specifies the current strong or weak ETag of the resource.
ICacheHeadersRequestContextAddon<R>	lastModified(Date lastModificationDate) Specifies the last modification date of the resource.
ICacheHeadersRequestContextAddon<R>	noCache() Sends "No Cache" headers so the resource is not cached at all by the client.
boolean	validate(boolean resourceCurrentlyExists) Call this when you are done setting ETag and/or Last-Modified to validate them agains the headers sent by the client.

Method Detail

eTag

ICacheHeadersRequestContextAddon<R> eTag(String currentTag)

Specifies the current ETag (strong) of the resource.

A strong comparison will be used to compare the request ETag to this current ETag.

Skip, or use null if the resource doesn't exist.

eTag

ICacheHeadersRequestContextAddon<R> eTag(String currentTag,
                                         boolean currentTagIsWeak)

Specifies the current strong or weak ETag of the resource.

A strong comparison will be used to compare the request ETag to this current ETag.

Skip, or use null if the resource doesn't exist.

eTag

ICacheHeadersRequestContextAddon<R> eTag(String currentTag,
                                         boolean currentTagIsWeak,
                                         boolean weakComparison)

Specifies the current strong or weak ETag of the resource.

Skip, or use null if the resource doesn't exist.

Parameters:

weakComparison - should a weak comparison be used instead of a strong one to compare the request ETag to the current ETag?

lastModified

ICacheHeadersRequestContextAddon<R> lastModified(Date lastModificationDate)

Specifies the last modification date of the resource.

Skip, or use null if the resource doesn't exist.

cache

ICacheHeadersRequestContextAddon<R> cache(int seconds)

The number of seconds the client should cache this resource before requesting it again.

cache

ICacheHeadersRequestContextAddon<R> cache(int seconds,
                                          boolean isPrivate)

The number of seconds the client should cache this resource before requesting it again.

Parameters:

isPrivate - should the cache be 'private'? (help)

cache

ICacheHeadersRequestContextAddon<R> cache(int seconds,
                                          boolean isPrivate,
                                          Integer secondsCdn)

The number of seconds the client should cache this resource before requesting it again.

Parameters:

isPrivate - should the cache be 'private'? (help)

secondsCdn - The number of seconds the resource associated with this route should be cached by a CDN/proxy. If null, it won't be used.

noCache

ICacheHeadersRequestContextAddon<R> noCache()

Sends "No Cache" headers so the resource is not cached at all by the client.

validate

boolean validate(boolean resourceCurrentlyExists)

Call this when you are done setting ETag and/or Last-Modified to validate them agains the headers sent by the client.

If this method returns true, the route handler should return immediately without returning/creating/modifying/deleting the associated resource! Appropriate headers have already been set on the response.

Parameters:

resourceCurrentlyExists - Does the resource currently exist?