org.ff4j.cache

Class FF4jCacheProxy

java.lang.Object

org.ff4j.cache.FF4jCacheProxy

All Implemented Interfaces:

FeatureStore, PropertyStore

public class FF4jCacheProxy
extends Object
implements FeatureStore, PropertyStore

Access to FeatureStore could generate some overhead and decrease performances. This is the reason why cache is provided though proxies. As applications are distributed, the cache itself could be distributed. The default implement is InMemoryFeatureStoreCacheProxy but other are provided to use distributed cache system as redis or memcached.

Author:

Cedrick Lunven (@clunven)

Constructor Summary

Constructors

Constructor and Description
FF4jCacheProxy() Allow Ioc and defeine default constructor.
FF4jCacheProxy(FeatureStore fStore, PropertyStore pStore, FF4JCacheManager cache) Initialization through constructor.

Method Summary

Modifier and Type	Method and Description
void	addToGroup(String featureId, String groupName) Add target Feature to target group.
void	clear() Empty features set.
void	create(Feature fp) Create flipPoint in storage (with roles).
<T> void	createProperty(Property<T> property) Create new property within store.
void	createSchema() Initialize the target database schema by creating expected structures.
void	delete(String featureId) Remove fliPoint from store.
void	deleteProperty(String name) Delete current property.
void	disable(String featureId) Create Feature is does not exist and enable it.
void	disableGroup(String groupName) Disable all features contained in the following group.
void	enable(String featureId) Enable/UP/switch on a FlipPoint.
void	enableGroup(String groupName) Enable all features contained in the following group.
boolean	exist(String featureId) Check if Feature Exist.
boolean	existGroup(String groupName) Check if current group exist or not.
boolean	existProperty(String propertyName) Check existence of target property.
String	getCachedTargetStore()
FF4JCacheManager	getCacheManager() Getter accessor for attribute 'cacheManager'.
String	getCacheProvider()
Store2CachePollingScheduler	getStore2CachePoller() Getter accessor for attribute 'store2CachePoller'.
FeatureStore	getTargetFeatureStore() Getter accessor for attribute 'target'.
PropertyStore	getTargetPropertyStore() Getter accessor for attribute 'target'.
void	grantRoleOnFeature(String featureId, String roleName) Add a role to a flipPOINT.
void	importFeatures(Collection<Feature> features) Import features.
void	importProperties(Collection<Property<?>> properties) Import a set of properties.
boolean	isCached()
boolean	isEmpty() Tell if a store is empty
Set<String>	listPropertyNames() List all property names.
Feature	read(String featureUid) Create Feature is does not exist and enable it.
Map<String,Feature>	readAll() Access to all features to get information.
Set<String>	readAllGroups() Return a set of existing groups.
Map<String,Property<?>>	readAllProperties() Retrieve all properties from store.
Map<String,Feature>	readGroup(String groupName) Read all features within target group.
Property<?>	readProperty(String name) Read property value.
Property<?>	readProperty(String name, Property<?> defaultValue) Read property value and if not found return the default value
void	removeFromGroup(String featureId, String groupName) Remove target Feature from group.
void	removeRoleFromFeature(String featureId, String roleName) Remove role to acess flip point
void	setCacheManager(FF4JCacheManager cacheManager) Setter accessor for attribute 'cacheManager'.
void	setStore2CachePoller(Store2CachePollingScheduler store2CachePoller) Setter accessor for attribute 'store2CachePoller'.
void	setTargetFeatureStore(FeatureStore targetFeatureStore) Setter accessor for attribute 'targetFeatureStore'.
void	setTargetPropertyStore(PropertyStore targetPropertyStore) Setter accessor for attribute 'targetPropertyStore'.
void	startPolling(long delay) Start the polling of target store is required.
void	stopPolling() Stop the polling of target store is required.
void	update(Feature fp) Update FlipPoint within store.
<T> void	updateProperty(Property<T> propertyValue) Update existing property.
void	updateProperty(String name, String newValue) Update existing property.

Methods inherited from class java.lang.Object

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

Constructor Detail

FF4jCacheProxy

public FF4jCacheProxy()

Allow Ioc and defeine default constructor.

FF4jCacheProxy

public FF4jCacheProxy(FeatureStore fStore,
                      PropertyStore pStore,
                      FF4JCacheManager cache)

Initialization through constructor.

Parameters:

store - target store to retrieve features

cache - cache manager to limit overhead of store

Method Detail

startPolling

public void startPolling(long delay)

Start the polling of target store is required.

stopPolling

public void stopPolling()

Stop the polling of target store is required.

enable

public void enable(String featureId)

Enable/UP/switch on a FlipPoint.

Specified by:

enable in interface FeatureStore

Parameters:

featureId - unique feature identifier

disable

public void disable(String featureId)

Create Feature is does not exist and enable it.

Specified by:

disable in interface FeatureStore

exist

public boolean exist(String featureId)

Check if Feature Exist.

Specified by:

exist in interface FeatureStore

Returns:

unique feature identifier

createSchema

public void createSchema()

Initialize the target database schema by creating expected structures.

TABLE, INDEX will be created for JDBC, but also COLLECTION and INDEXS for MongoDb, or COLUMN FAMILY for Cassandra. The structures will be created only if they don't exist. In some cases, there is nothing todo (Ehcache, Redis, InMemory), the method won't failed but do nothing (it does not clear the DB)

Specified by:

createSchema in interface FeatureStore

Specified by:

createSchema in interface PropertyStore

create

public void create(Feature fp)

Create flipPoint in storage (with roles).

Specified by:

create in interface FeatureStore

Parameters:

fp - create roles

read

public Feature read(String featureUid)

Create Feature is does not exist and enable it.

Specified by:

read in interface FeatureStore

readAll

public Map<String,Feature> readAll()

Access to all features to get information.

Specified by:

readAll in interface FeatureStore

Returns:

all features

readAllGroups

public Set<String> readAllGroups()

Return a set of existing groups.

Specified by:

readAllGroups in interface FeatureStore

Returns:

set of group in the store

delete

public void delete(String featureId)

Remove fliPoint from store.

Specified by:

delete in interface FeatureStore

update

public void update(Feature fp)

Update FlipPoint within store.

Specified by:

update in interface FeatureStore

Parameters:

fp - flipPoint new element

grantRoleOnFeature

public void grantRoleOnFeature(String featureId,
                               String roleName)

Add a role to a flipPOINT.

Specified by:

grantRoleOnFeature in interface FeatureStore

removeRoleFromFeature

public void removeRoleFromFeature(String featureId,
                                  String roleName)

Remove role to acess flip point

Specified by:

removeRoleFromFeature in interface FeatureStore

enableGroup

public void enableGroup(String groupName)

Enable all features contained in the following group.

Specified by:

enableGroup in interface FeatureStore

Parameters:

groupName - target group name

disableGroup

public void disableGroup(String groupName)

Disable all features contained in the following group.

Specified by:

disableGroup in interface FeatureStore

Parameters:

groupName - target group name

existGroup

public boolean existGroup(String groupName)

Check if current group exist or not.

Specified by:

existGroup in interface FeatureStore

Parameters:

groupName - target group name

readGroup

public Map<String,Feature> readGroup(String groupName)

Read all features within target group.

Specified by:

readGroup in interface FeatureStore

Parameters:

groupName - target group name

Returns:

return all feature from group or groupnotfoundException if does not exist

addToGroup

public void addToGroup(String featureId,
                       String groupName)

Add target Feature to target group.

Specified by:

addToGroup in interface FeatureStore

Parameters:

featureId - target feature identifier

groupName - target groupName

removeFromGroup

public void removeFromGroup(String featureId,
                            String groupName)

Remove target Feature from group.

Specified by:

removeFromGroup in interface FeatureStore

Parameters:

featureId - target feature identifier

groupName - target groupName

getTargetFeatureStore

public FeatureStore getTargetFeatureStore()

Getter accessor for attribute 'target'.

Returns:

current value of 'target'

getTargetPropertyStore

public PropertyStore getTargetPropertyStore()

Getter accessor for attribute 'target'.

Returns:

current value of 'target'

getCacheManager

public FF4JCacheManager getCacheManager()

Getter accessor for attribute 'cacheManager'.

Returns:

current value of 'cacheManager'

setCacheManager

public void setCacheManager(FF4JCacheManager cacheManager)

Setter accessor for attribute 'cacheManager'.

Parameters:

cacheManager - new value for 'cacheManager '

isCached

public boolean isCached()

getCacheProvider

public String getCacheProvider()

getCachedTargetStore

public String getCachedTargetStore()

readAllProperties

public Map<String,Property<?>> readAllProperties()

Retrieve all properties from store.

Specified by:

readAllProperties in interface PropertyStore

Returns:

all properties from store

existProperty

public boolean existProperty(String propertyName)

Check existence of target property.

Specified by:

existProperty in interface PropertyStore

Parameters:

propertyName - target name

Returns:

if the property exist

createProperty

public <T> void createProperty(Property<T> property)

Create new property within store.

Specified by:

createProperty in interface PropertyStore

Parameters:

property - target value

readProperty

public Property<?> readProperty(String name)

Read property value.

Specified by:

readProperty in interface PropertyStore

Parameters:

name - target property name

Returns:

property of exist

readProperty

public Property<?> readProperty(String name,
                                Property<?> defaultValue)

Read property value and if not found return the default value

Specified by:

readProperty in interface PropertyStore

Parameters:

name - target property name

Returns:

property of exist

updateProperty

public void updateProperty(String name,
                           String newValue)

Update existing property.

Specified by:

updateProperty in interface PropertyStore

Parameters:

name - target name

newValue - new value

updateProperty

public <T> void updateProperty(Property<T> propertyValue)

Update existing property.

Specified by:

updateProperty in interface PropertyStore

deleteProperty

public void deleteProperty(String name)

Delete current property.

Specified by:

deleteProperty in interface PropertyStore

Parameters:

name - target name

isEmpty

public boolean isEmpty()

Tell if a store is empty

Specified by:

isEmpty in interface PropertyStore

Returns:

target store

listPropertyNames

public Set<String> listPropertyNames()

List all property names.

Specified by:

listPropertyNames in interface PropertyStore

Returns:

clear

public void clear()

Empty features set.

Specified by:

clear in interface FeatureStore

Specified by:

clear in interface PropertyStore

importProperties

public void importProperties(Collection<Property<?>> properties)

Import a set of properties.

Specified by:

importProperties in interface PropertyStore

Parameters:

properties - a set of properties

importFeatures

public void importFeatures(Collection<Feature> features)

Import features.

Specified by:

importFeatures in interface FeatureStore

Parameters:

features - list of features.s

setTargetFeatureStore

public void setTargetFeatureStore(FeatureStore targetFeatureStore)

Setter accessor for attribute 'targetFeatureStore'.

Parameters:

targetFeatureStore - new value for 'targetFeatureStore '

setTargetPropertyStore

public void setTargetPropertyStore(PropertyStore targetPropertyStore)

Setter accessor for attribute 'targetPropertyStore'.

Parameters:

targetPropertyStore - new value for 'targetPropertyStore '

getStore2CachePoller

public Store2CachePollingScheduler getStore2CachePoller()

Getter accessor for attribute 'store2CachePoller'.

Returns:

current value of 'store2CachePoller'

setStore2CachePoller

public void setStore2CachePoller(Store2CachePollingScheduler store2CachePoller)

Setter accessor for attribute 'store2CachePoller'.

Parameters:

store2CachePoller - new value for 'store2CachePoller '