org.ff4j.cache

Class InMemoryCacheManager

java.lang.Object

org.ff4j.cache.InMemoryCacheManager

All Implemented Interfaces:

FF4JCacheManager

public class InMemoryCacheManager
extends Object
implements FF4JCacheManager

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 (@clunven)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CACHENAME cache name if several caches within memory.

Constructor Summary

Constructors

Constructor and Description
InMemoryCacheManager()

Method Summary

Modifier and Type	Method and Description
void	clearFeatures() Remove everything present within feature cache.
void	clearProperties() Remove everything present within properties cache.
void	evictFeature(String featureId) Remove a feature from cache by its identifier.
void	evictProperty(String propertyName) Remove a property from cache by its identifier.
String	getCacheProviderName() Get name of expected cache.
Feature	getFeature(String featureId) Return Feature stored in cache.
Object	getFeatureNativeCache() Access to embedded implementation of cache for Features.
Map<String,InMemoryCacheEntry<Feature>>	getFeaturesCache() Getter accessor for attribute 'featuresCache'.
Property<?>	getProperty(String pName) Return PropertyString stored in cache.
Map<String,InMemoryCacheEntry<Property<?>>>	getPropertyCache() Getter accessor for attribute 'propertyCache'.
Object	getPropertyNativeCache() Access to embedded implementation of cach for Properties
Set<String>	listCachedFeatureNames() List feature names in cache.
Set<String>	listCachedPropertyNames() List property names in cache.
void	putFeature(Feature feat) Add feature to cache.
void	putFeature(Feature feat, long timeToLive)
void	putProperty(Property<?> prop) Add property to cache.
void	putProperty(Property<?> prop, long timeToLive)

Methods inherited from class java.lang.Object

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

Field Detail

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

getCacheProviderName

public String getCacheProviderName()

Get name of expected cache.

Specified by:

getCacheProviderName in interface FF4JCacheManager

Returns:

target cache name

listCachedFeatureNames

public Set<String> listCachedFeatureNames()

List feature names in cache.

Specified by:

listCachedFeatureNames in interface FF4JCacheManager

Returns:

feature names in cache

clearFeatures

public void clearFeatures()

Remove everything present within feature cache.

Specified by:

clearFeatures in interface FF4JCacheManager

clearProperties

public void clearProperties()

Remove everything present within properties cache.

Specified by:

clearProperties in interface FF4JCacheManager

evictFeature

public void evictFeature(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:

evictFeature in interface FF4JCacheManager

Parameters:

featureId - feature identifier

evictProperty

public void evictProperty(String propertyName)

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

Specified by:

evictProperty in interface FF4JCacheManager

Parameters:

propertyName - property unique identifier

putFeature

public void putFeature(Feature feat)

Add feature to cache.

Specified by:

putFeature in interface FF4JCacheManager

Parameters:

feat - target feature to be cached

putFeature

public void putFeature(Feature feat,
                       long timeToLive)

putProperty

public void putProperty(Property<?> prop)

Add property to cache.

Specified by:

putProperty in interface FF4JCacheManager

Parameters:

prop - target property to be cached

putProperty

public void putProperty(Property<?> prop,
                        long timeToLive)

getFeature

public Feature getFeature(String featureId)

Return Feature stored in cache.

Specified by:

getFeature in interface FF4JCacheManager

Parameters:

featureId - target feature identifier

Returns:

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

getProperty

public Property<?> getProperty(String pName)

Return PropertyString stored in cache.

Specified by:

getProperty in interface FF4JCacheManager

Parameters:

pName - target feature identifier

Returns:

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

listCachedPropertyNames

public Set<String> listCachedPropertyNames()

List property names in cache.

Specified by:

listCachedPropertyNames in interface FF4JCacheManager

Returns:

feature names in cache

getFeatureNativeCache

public Object getFeatureNativeCache()

Access to embedded implementation of cache for Features.

Specified by:

getFeatureNativeCache in interface FF4JCacheManager

Returns:

native implementation of cache.

getPropertyNativeCache

public Object getPropertyNativeCache()

Access to embedded implementation of cach for Properties

Specified by:

getPropertyNativeCache in interface FF4JCacheManager

Returns:

native implementation of cache.

getFeaturesCache

public Map<String,InMemoryCacheEntry<Feature>> getFeaturesCache()

Getter accessor for attribute 'featuresCache'.

Returns:

current value of 'featuresCache'

getPropertyCache

public Map<String,InMemoryCacheEntry<Property<?>>> getPropertyCache()

Getter accessor for attribute 'propertyCache'.

Returns:

current value of 'propertyCache'