org.ff4j.cache

Interface FF4JCacheManager

All Known Implementing Classes:

InMemoryCacheManager

public interface FF4JCacheManager

Cache Layer on top of FeatureStore to enhance performances.

Author:

Cedrick Lunven (@clunven)

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.
Property<?>	getProperty(String featureId) Return PropertyString stored in cache.
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	putProperty(Property<?> feat) Add property to cache.

Method Detail

clearFeatures

void clearFeatures()

Remove everything present within feature cache.

clearProperties

void clearProperties()

Remove everything present within properties cache.

evictFeature

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.

Parameters:

featureId - feature identifier

evictProperty

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.

Parameters:

propertyName - property unique identifier

putFeature

void putFeature(Feature feat)

Add feature to cache.

Parameters:

feat - target feature to be cached

putProperty

void putProperty(Property<?> feat)

Add property to cache.

Parameters:

feat - target property to be cached

getFeature

Feature getFeature(String featureId)

Return Feature stored in cache.

Parameters:

featureId - target feature identifier

Returns:

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

getProperty

Property<?> getProperty(String featureId)

Return PropertyString stored in cache.

Parameters:

featureId - target feature identifier

Returns:

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

listCachedFeatureNames

Set<String> listCachedFeatureNames()

List feature names in cache.

Returns:

feature names in cache

listCachedPropertyNames

Set<String> listCachedPropertyNames()

List property names in cache.

Returns:

feature names in cache

getFeatureNativeCache

Object getFeatureNativeCache()

Access to embedded implementation of cache for Features.

Returns:

native implementation of cache.

getPropertyNativeCache

Object getPropertyNativeCache()

Access to embedded implementation of cach for Properties

Returns:

native implementation of cache.

getCacheProviderName

String getCacheProviderName()

Get name of expected cache.

Returns:

target cache name