Class CacheProcessorBase

java.lang.Object

org.frontcache.cache.CacheProcessorBase

All Implemented Interfaces:

CacheProcessor

Direct Known Subclasses:

InMemoryCacheProcessor, L1L2CacheProcessor, NoopCacheProcessor

public abstract class CacheProcessorBase
extends Object
implements CacheProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	logger
protected ExecutorService	softInvalidationExecutor

Fields inherited from interface CacheProcessor

CACHE_FOREVER, CACHED_ENTRIES, NO_CACHE

Constructor Summary

Constructors

Constructor	Description
CacheProcessorBase()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doSoftInvalidation(String currentRequestURL, String originUrlStr, Map<String, List<String>> requestHeaders, FcHttpClient client, RequestContext context)	perform async invalidation
Map<String,String>	getCacheStatus()
final WebResponse	getFromCache(String url, RequestContext context)
abstract WebResponse	getFromCacheImpl(String url)
void	init(Properties properties)
WebResponse	processRequest(String originUrlStr, Map<String, List<String>> requestHeaders, FcHttpClient client, RequestContext context)
final void	putToCache(String url, WebResponse component)	Single entry point for writing to the cache.
abstract void	putToCacheImpl(String url, WebResponse component)	Stores the entry.

Methods inherited from class Object

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

Methods inherited from interface CacheProcessor

backup, getCachedKeys, getCachedKeys, getCacheStats, patch, purge, removeFromCache, removeFromCacheAll

Field Details

logger

protected org.slf4j.Logger logger

softInvalidationExecutor

protected ExecutorService softInvalidationExecutor

Constructor Details

CacheProcessorBase

public CacheProcessorBase()

Method Details

getFromCacheImpl

public abstract WebResponse getFromCacheImpl(String url)

putToCacheImpl

public abstract void putToCacheImpl(String url,
 WebResponse component)

Stores the entry. Called by putToCache(String, WebResponse) once the headers that must never be persisted (Set-Cookie in particular) have been removed.

Parameters:

url - cache key

component - response to store - the cache takes ownership of it

putToCache

public final void putToCache(String url,
 WebResponse component)

Single entry point for writing to the cache. The header strip lives here rather than in the callers so that no write path can bypass it - the origin/refresh paths below, the admin API (FrontCacheIOServlet) and replication all end up here. Caching a Set-Cookie would replay one visitor's session cookie to every later visitor. The response is modified in place, so callers must hand over an instance that is not being served to a client (the origin paths below pass a copy() - that is what keeps the visitor's own Set-Cookie on the live response of a cache miss).

Specified by:

putToCache in interface CacheProcessor

getFromCache

public final WebResponse getFromCache(String url,
 RequestContext context)

Specified by:

getFromCache in interface CacheProcessor

processRequest

public WebResponse processRequest(String originUrlStr,
 Map<String, List<String>> requestHeaders,
 FcHttpClient client,
 RequestContext context)
                           throws FrontCacheException

Specified by:

processRequest in interface CacheProcessor

Throws:

FrontCacheException

doSoftInvalidation

public void doSoftInvalidation(String currentRequestURL,
 String originUrlStr,
 Map<String, List<String>> requestHeaders,
 FcHttpClient client,
 RequestContext context)

perform async invalidation

Specified by:

doSoftInvalidation in interface CacheProcessor

Parameters:

currentRequestURL -

originUrlStr -

requestHeaders -

client -

context -

getCacheStatus

public Map<String,String> getCacheStatus()

Specified by:

getCacheStatus in interface CacheProcessor

init

public void init(Properties properties)

Specified by:

init in interface CacheProcessor

destroy

public void destroy()

Specified by:

destroy in interface CacheProcessor