com.github.dandelion.core.cache

Interface RequestCache

All Known Implementing Classes:

AbstractRequestCache, EhCacheRequestCache, MemoryRequestCache

public interface RequestCache

SPI for all implementation of RequestCache.

Dandelion provides one out-of-the-box service provider:

• MemoryRequestCache that uses the memory to store cache entries.

Since:

0.10.0

Author:

Romain Lespinasse, Thibault Duchateau

Field Summary

Fields

Modifier and Type	Field and Description
static String	DANDELION_CACHE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all objects stored in cache.
CacheEntry	get(String cacheKey) Gets the set of assets to be displayed for a request stored under the passed cacheKey.
Collection<CacheEntry>	getAll()
String	getCacheName()
AtomicLong	getGetCount()
AtomicLong	getHitCount()
AtomicLong	getMissCount()
AtomicLong	getPutCount()
void	initCache(Context context) Initializes the configured service provider of the RequestCache SPI by using the Context.
void	put(String cacheKey, CacheEntry cacheElement) Puts the passed assets to the cache.

Field Detail

DANDELION_CACHE_NAME

static final String DANDELION_CACHE_NAME

See Also:

Constant Field Values

Method Detail

initCache

void initCache(Context context)

Initializes the configured service provider of the RequestCache SPI by using the Context.

Parameters:

context - The Context initialized in the DandelionFilter .

getCacheName

String getCacheName()

Returns:

the name of the asset cache.

get

CacheEntry get(String cacheKey)

Gets the set of assets to be displayed for a request stored under the passed cacheKey.

Parameters:

cacheKey - The cache key under which the set of assets is stored in the cache.

Returns:

the assets associated with the cache key.

getAll

Collection<CacheEntry> getAll()

put

void put(String cacheKey,
       CacheEntry cacheElement)

Puts the passed assets to the cache.

Parameters:

cacheKey - The key used to puts the assets to the cache.

cacheElement - The assets to store in the cache.

getGetCount

AtomicLong getGetCount()

getPutCount

AtomicLong getPutCount()

getHitCount

AtomicLong getHitCount()

getMissCount

AtomicLong getMissCount()

clear

void clear()

Clear all objects stored in cache.