org.ff4j.store

Class AbstractFeatureStore

java.lang.Object

org.ff4j.store.AbstractFeatureStore

All Implemented Interfaces:

FeatureStore

Direct Known Subclasses:

InMemoryFeatureStore, JdbcFeatureStore, KeyValueFeatureStore

public abstract class AbstractFeatureStore
extends Object
implements FeatureStore

SuperClass for stores.

Author:

Cedrick Lunven (@clunven)

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureStore()

Method Summary

Modifier and Type	Method and Description
void	addToGroup(String featureId, String groupName) Add target Feature to target group.
protected void	assertFeatureExist(String uid) Validate feature uid.
protected void	assertFeatureNotExist(String uid) Check that current feature does not exist.
protected void	assertFeatureNotNull(Feature feature) Validate feature uid.
protected void	assertGroupExist(String groupName) Validate feature uid.
void	createSchema() Initialize the target database schema by creating expected structures.
void	disable(String uid) Create Feature is does not exist and enable it.
void	disableGroup(String groupName) Disable all features contained in the following group.
void	enable(String uid) Enable/UP/switch on a FlipPoint.
void	enableGroup(String groupName) Enable all features contained in the following group.
boolean	existGroup(String groupName) Check if current group exist or not.
void	grantRoleOnFeature(String flipId, String roleName) Add a role to a flipPOINT.
void	importFeatures(Collection<Feature> features) Import features from a set of feature.
Map<String,Feature>	importFeaturesFromXmlFile(String xmlConfFile) Initialize store from XML Configuration File.
Set<String>	readAllGroups() Return a set of existing groups.
Map<String,Feature>	readGroup(String groupName) Read all features within target group.
void	removeFromGroup(String featureId, String groupName) Remove target Feature from group.
void	removeRoleFromFeature(String flipId, String roleName) Remove role to acess flip point
String	toJson()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ff4j.core.FeatureStore

clear, create, delete, exist, read, readAll, update

Constructor Detail

AbstractFeatureStore

public AbstractFeatureStore()

Method Detail

importFeaturesFromXmlFile

public Map<String,Feature> importFeaturesFromXmlFile(String xmlConfFile)

Initialize store from XML Configuration File.

Parameters:

xmlConfFile - xml configuration file

enable

public void enable(String uid)

Enable/UP/switch on a FlipPoint.

Specified by:

enable in interface FeatureStore

Parameters:

uid - unique feature identifier

disable

public void disable(String uid)

Create Feature is does not exist and enable it.

Specified by:

disable in interface FeatureStore

grantRoleOnFeature

public void grantRoleOnFeature(String flipId,
                               String roleName)

Add a role to a flipPOINT.

Specified by:

grantRoleOnFeature in interface FeatureStore

removeRoleFromFeature

public void removeRoleFromFeature(String flipId,
                                  String roleName)

Remove role to acess flip point

Specified by:

removeRoleFromFeature in interface FeatureStore

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

existGroup

public boolean existGroup(String groupName)

Check if current group exist or not.

Specified by:

existGroup in interface FeatureStore

Parameters:

groupName - target group name

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

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

readAllGroups

public Set<String> readAllGroups()

Return a set of existing groups.

Specified by:

readAllGroups in interface FeatureStore

Returns:

set of group in the store

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

importFeatures

public void importFeatures(Collection<Feature> features)

Import features from a set of feature.

Specified by:

importFeatures in interface FeatureStore

Parameters:

features -

toJson

public String toJson()

toString

public String toString()

Overrides:

toString in class Object

assertFeatureExist

protected void assertFeatureExist(String uid)

Validate feature uid.

Parameters:

uid - target uid

assertFeatureNotExist

protected void assertFeatureNotExist(String uid)

Check that current feature does not exist.

Parameters:

uid - current feature identifier.s

assertGroupExist

protected void assertGroupExist(String groupName)

Validate feature uid.

Parameters:

uid - target uid

assertFeatureNotNull

protected void assertFeatureNotNull(Feature feature)

Validate feature uid.

Parameters:

uid - target uid