org.ff4j.store

Class JdbcFeatureStore

java.lang.Object

org.ff4j.store.AbstractFeatureStore

org.ff4j.store.JdbcFeatureStore

All Implemented Interfaces:

FeatureStore

public class JdbcFeatureStore
extends AbstractFeatureStore

Implementation of FeatureStore to work with RDBMS through JDBC.

Author:

Cedrick Lunven (@clunven)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANNOT_CHECK_FEATURE_EXISTENCE_ERROR_RELATED_TO_DATABASE Error message 1.
static String	CANNOT_UPDATE_FEATURES_DATABASE_SQL_ERROR Error message 2.

Constructor Summary

Constructors

Constructor and Description
JdbcFeatureStore() Default Constructor.
JdbcFeatureStore(DataSource jdbcDS) Constructor from DataSource.
JdbcFeatureStore(DataSource jdbcDS, String xmlConfFile) Constructor from DataSource.

Method Summary

Modifier and Type	Method and Description
void	addToGroup(String uid, String groupName) Add target Feature to target group.
void	clear() Empty features set.
void	create(Feature fp) Create flipPoint in storage (with roles).
void	createCustomProperties(String uid, Collection<Property<?>> props) Ease creation of properties in Database.
void	createSchema() Initialize the target database schema by creating expected structures.
void	delete(String uid) Remove fliPoint from store.
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	exist(String uid) Check if Feature Exist.
boolean	existGroup(String groupName) Check if current group exist or not.
DataSource	getDataSource() Getter accessor for attribute 'dataSource'.
JdbcQueryBuilder	getQueryBuilder()
void	grantRoleOnFeature(String uid, String roleName) Add a role to a flipPOINT.
Feature	read(String uid) 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,Feature>	readGroup(String groupName) Read all features within target group.
void	removeFromGroup(String uid, String groupName) Remove target Feature from group.
void	removeRoleFromFeature(String uid, String roleName) Remove role to acess flip point
void	setDataSource(DataSource dataSource) Setter accessor for attribute 'dataSource'.
void	setQueryBuilder(JdbcQueryBuilder queryBuilder)
void	update(Feature fp) Update FlipPoint within store.
void	update(String query, Object... params) Utility method to perform UPDATE and DELETE operations.

Methods inherited from class org.ff4j.store.AbstractFeatureStore

assertFeatureExist, assertFeatureNotExist, assertFeatureNotNull, assertGroupExist, importFeatures, importFeaturesFromXmlFile, toJson, toString

Methods inherited from class java.lang.Object

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

Field Detail

CANNOT_CHECK_FEATURE_EXISTENCE_ERROR_RELATED_TO_DATABASE

public static final String CANNOT_CHECK_FEATURE_EXISTENCE_ERROR_RELATED_TO_DATABASE

Error message 1.

See Also:

Constant Field Values

CANNOT_UPDATE_FEATURES_DATABASE_SQL_ERROR

public static final String CANNOT_UPDATE_FEATURES_DATABASE_SQL_ERROR

Error message 2.

See Also:

Constant Field Values

Constructor Detail

JdbcFeatureStore

public JdbcFeatureStore()

Default Constructor.

JdbcFeatureStore

public JdbcFeatureStore(DataSource jdbcDS)

Constructor from DataSource.

Parameters:

jdbcDS - native jdbc datasource

JdbcFeatureStore

public JdbcFeatureStore(DataSource jdbcDS,
                        String xmlConfFile)

Constructor from DataSource.

Parameters:

jdbcDS - native jdbc datasource

Method Detail

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

Overrides:

createSchema in class AbstractFeatureStore

enable

public void enable(String uid)

Enable/UP/switch on a FlipPoint.

Specified by:

enable in interface FeatureStore

Overrides:

enable in class AbstractFeatureStore

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

Overrides:

disable in class AbstractFeatureStore

exist

public boolean exist(String uid)

Check if Feature Exist.

Returns:

unique feature identifier

read

public Feature read(String uid)

Create Feature is does not exist and enable it.

create

public void create(Feature fp)

Create flipPoint in storage (with roles).

Parameters:

fp - create roles

delete

public void delete(String uid)

Remove fliPoint from store.

grantRoleOnFeature

public void grantRoleOnFeature(String uid,
                               String roleName)

Add a role to a flipPOINT.

Specified by:

grantRoleOnFeature in interface FeatureStore

Overrides:

grantRoleOnFeature in class AbstractFeatureStore

removeRoleFromFeature

public void removeRoleFromFeature(String uid,
                                  String roleName)

Remove role to acess flip point

Specified by:

removeRoleFromFeature in interface FeatureStore

Overrides:

removeRoleFromFeature in class AbstractFeatureStore

readAll

public Map<String,Feature> readAll()

Access to all features to get information.

Returns:

all features

readAllGroups

public Set<String> readAllGroups()

Return a set of existing groups.

Specified by:

readAllGroups in interface FeatureStore

Overrides:

readAllGroups in class AbstractFeatureStore

Returns:

set of group in the store

update

public void update(Feature fp)

Update FlipPoint within store.

Parameters:

fp - flipPoint new element

clear

public void clear()

Empty features set.

createCustomProperties

public void createCustomProperties(String uid,
                                   Collection<Property<?>> props)

Ease creation of properties in Database.

Parameters:

uid - target unique identifier

props - target properties.

existGroup

public boolean existGroup(String groupName)

Check if current group exist or not.

Specified by:

existGroup in interface FeatureStore

Overrides:

existGroup in class AbstractFeatureStore

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

Overrides:

enableGroup in class AbstractFeatureStore

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

Overrides:

disableGroup in class AbstractFeatureStore

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

Overrides:

readGroup in class AbstractFeatureStore

Parameters:

groupName - target group name

Returns:

return all feature from group or groupnotfoundException if does not exist

addToGroup

public void addToGroup(String uid,
                       String groupName)

Add target Feature to target group.

Specified by:

addToGroup in interface FeatureStore

Overrides:

addToGroup in class AbstractFeatureStore

Parameters:

uid - target feature identifier

groupName - target groupName

removeFromGroup

public void removeFromGroup(String uid,
                            String groupName)

Remove target Feature from group.

Specified by:

removeFromGroup in interface FeatureStore

Overrides:

removeFromGroup in class AbstractFeatureStore

Parameters:

uid - target feature identifier

groupName - target groupName

update

public void update(String query,
                   Object... params)

Utility method to perform UPDATE and DELETE operations.

Parameters:

query - target query

params - sql query params

getDataSource

public DataSource getDataSource()

Getter accessor for attribute 'dataSource'.

Returns:

current value of 'dataSource'

setDataSource

public void setDataSource(DataSource dataSource)

Setter accessor for attribute 'dataSource'.

Parameters:

dataSource - new value for 'dataSource '

getQueryBuilder

public JdbcQueryBuilder getQueryBuilder()

Returns:

the queryBuilder

setQueryBuilder

public void setQueryBuilder(JdbcQueryBuilder queryBuilder)

Parameters:

queryBuilder - the queryBuilder to set