org.ff4j.cache

Class InMemoryCacheManager

java.lang.Object

org.ff4j.cache.InMemoryCacheManager

All Implemented Interfaces:

FeatureCacheManager

public class InMemoryCacheManager
extends Object
implements FeatureCacheManager

Proposition of inmemory cache implementation. Warn : DO NOT USE THIS CACHE WHEN WORKING WITH EXTERNAL FEATURESTORE (as Database) and cluster application : EACH NODE GOT ITS MEMORY AND AN MODIFICATION IN STORE WON'T REFRESH THIS CACHE. Please use REDIS/MEMCACHED implementations.

Author:

Cedrick LUNVEN

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CACHENAME cache name if several caches within memory.
static long	DEFAULT_TTL Default TTL is one hour.
static long	TO_MILLIS externalized as constant.

Constructor Summary

Constructors

Constructor and Description
InMemoryCacheManager()

Method Summary

Modifier and Type	Method and Description
void	clear() Remove everything present within cache.
void	evict(String featureId) Remove a feature from cache by its identifier.
Feature	get(String featureId) Return feature stored in cache.
String	getCacheProviderName() Get name of expected cache.
Object	getNativeCache() Access to embedded implementation of cache.
long	getTtl() Getter accessor for attribute 'ttl'.
Set<String>	listCachedFeatureNames() List feature names in cache.
void	put(Feature feat) Add feature to cache.
void	setTtl(long ttl) Setter accessor for attribute 'ttl'.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TTL

public static final long DEFAULT_TTL

Default TTL is one hour.

See Also:

Constant Field Values

TO_MILLIS

public static final long TO_MILLIS

externalized as constant.

See Also:

Constant Field Values

DEFAULT_CACHENAME

public static final String DEFAULT_CACHENAME

cache name if several caches within memory.

See Also:

Constant Field Values

Constructor Detail

InMemoryCacheManager

public InMemoryCacheManager()

Method Detail

clear

public void clear()

Remove everything present within cache.

Specified by:

clear in interface FeatureCacheManager

evict

public void evict(String featureId)

Remove a feature from cache by its identifier. Could be invoked for any modification of target feature through store or when time-to-live reached.

Specified by:

evict in interface FeatureCacheManager

Parameters:

featureId - feature identifier

put

public void put(Feature feat)

Add feature to cache.

Specified by:

put in interface FeatureCacheManager

Parameters:

feat - target feature to be cached

get

public Feature get(String featureId)

Return feature stored in cache.

Specified by:

get in interface FeatureCacheManager

Parameters:

featureId - target feature identifier

Returns:

target feature if exist (could raise FeatureNotFoundException as FeatureStore).

getCacheProviderName

public String getCacheProviderName()

Get name of expected cache.

Specified by:

getCacheProviderName in interface FeatureCacheManager

Returns:

target cache name

listCachedFeatureNames

public Set<String> listCachedFeatureNames()

List feature names in cache.

Specified by:

listCachedFeatureNames in interface FeatureCacheManager

Returns:

feature names in cache

getNativeCache

public Object getNativeCache()

Access to embedded implementation of cache.

Specified by:

getNativeCache in interface FeatureCacheManager

Returns:

native implementation of cache.

getTtl

public long getTtl()

Getter accessor for attribute 'ttl'.

Returns:

current value of 'ttl'

setTtl

public void setTtl(long ttl)

Setter accessor for attribute 'ttl'.

Parameters:

ttl - new value for 'ttl '