org.dd4t.providers

Interface PayloadCacheProvider

public interface PayloadCacheProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String cacheKey, String dependencyKey) Adds a dependency between two cache keys
<T> CacheElement<T>	loadPayloadFromLocalCache(String key) Loads object corresponding to the given key from cache.
<T> void	storeInItemCache(String key, CacheElement<T> cacheElement) Store given item in the cache with a simple time-to-live property (for items not depending on Tridion items)
<T> void	storeInItemCache(String key, CacheElement<T> cacheElement, int dependingPublicationId, int dependingItemId) Store given item in the cache with a reference to supplied Tridion Item.
<T> void	storeInItemCache(String key, CacheElement<T> cacheElement, List<CacheDependency> dependencies) Stores item in the cache with a reference to all given depdencies

Method Detail

loadPayloadFromLocalCache

<T> CacheElement<T> loadPayloadFromLocalCache(String key)

Loads object corresponding to the given key from cache. Method always returns a non-null CacheElement that wraps around the actual payload object. Payload can be null and can also be expired, which denotes the payload is stale and needs updating, but can still be used while updating is complete.

Parameters:

key - String representing the name under which the object is stored in the cache

Returns:

CacheElement the wrapper around the actual payload object in cache

storeInItemCache

<T> void storeInItemCache(String key,
                        CacheElement<T> cacheElement)

Store given item in the cache with a simple time-to-live property (for items not depending on Tridion items)

Parameters:

key - String representing the name under which the object is stored in the cache

cacheElement - CacheElement representing wrapper around the actual payload to store in cache

storeInItemCache

<T> void storeInItemCache(String key,
                        CacheElement<T> cacheElement,
                        int dependingPublicationId,
                        int dependingItemId)

Store given item in the cache with a reference to supplied Tridion Item.

Parameters:

key - String representing the name under which the object is stored in the cache

cacheElement - CacheElement representing wrapper around the actual payload to store in cache

dependingPublicationId - int representing the Publication id of the Tridion item the cacheItem depends on

dependingItemId - int representing the Item id of the Tridion item the cacheItem depends on

storeInItemCache

<T> void storeInItemCache(String key,
                        CacheElement<T> cacheElement,
                        List<CacheDependency> dependencies)

Stores item in the cache with a reference to all given depdencies

Parameters:

key - String representing the name under which the object is stored in the cache

cacheElement - CacheElement representing wrapper around the actual payload to store in cache

dependencies - List of CacheDependency objects, representing the dependencies for this item

addDependency

void addDependency(String cacheKey,
                 String dependencyKey)

Adds a dependency between two cache keys

Parameters:

cacheKey - String representing the key of the cache item that will flush if the other item flushes

dependencyKey - String representing the key of the cache item that will act as a dependency