info.magnolia.module.cache.filter

Interface CachedEntry

All Superinterfaces:

Serializable

All Known Implementing Classes:

CachedError, CachedRedirect, ContentCachedEntry, DelegatingBlobCachedEntry, InMemoryCachedEntry, SingleReplayCacheEntryWrapper, UncacheableEntry

public interface CachedEntry
extends Serializable

A cached entry used to store content produced by the filter chain. The cache can be replayed.

Version:

$Revision: $ ($Author: $)

Method Summary

Methods

Modifier and Type	Method and Description
long	getLastModificationTime() Produce last modification date of the cache entry.
String	getOriginalURL() Entry might be required to produce url used to create it in the first place.
int	getTimeToLiveInSeconds()
void	replay(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)

Method Detail

replay

void replay(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          javax.servlet.FilterChain chain)
            throws IOException,
                   javax.servlet.ServletException

Parameters:

chain - a cache entry might want to delegate to the filter chain, see DelegatingBlobCachedEntry.replay(HttpServletRequest, HttpServletResponse, FilterChain)

Throws:

IOException

javax.servlet.ServletException

getOriginalURL

String getOriginalURL()

Entry might be required to produce url used to create it in the first place.

Returns:

URL that triggered cache entry creation.

getLastModificationTime

long getLastModificationTime()

Produce last modification date of the cache entry. If no other time can be discerned, the time of entry creation should be returned.

Returns:

time when cached entry was last modified. This time should reflect real modification time of the cached content.

getTimeToLiveInSeconds

int getTimeToLiveInSeconds()