org.ff4j

Class FF4j

java.lang.Object

org.ff4j.FF4j

public class FF4j
extends Object

Main class, it allows to work with features.

• It embeddes a FeatureStore to record features statused. By default, features are stored into memory but you would like to persist them in an external storage (as database) and choose among implementations available in different modules (jdbc, mongo, http...).

• It embeddes a AuthorizationsManager to add permissions and limit usage of features to granted people. FF4J does not created roles, it's rely on external security provider as SpringSecurity Apache Chiro.

• It embeddes a EventRepository to monitoring actions performed on features.

Author:

Cedrick LUNVEN

Constructor Summary

Constructors

Constructor and Description
FF4j() Default constructor to allows instantiation through IoC.
FF4j(InputStream xmlFileResourceAsStream) Constructor initializing ff4j with an InMemoryStore using an InputStream.
FF4j(String xmlFile) Constructor initializing ff4j with an InMemoryStore

Method Summary

Modifier and Type	Method and Description
FF4j	autoCreate(boolean flag) Enable autocreation of features when not found.
boolean	check(String featureID) Ask if flipped.
boolean	check(String featureID, FlippingExecutionContext executionContext) Elegant way to ask for flipping.
boolean	checkOveridingStrategy(String featureID, FlippingStrategy strats) Overriding strategy on feature.
boolean	checkOveridingStrategy(String featureID, FlippingStrategy strats, FlippingExecutionContext executionContext) Overriding strategy on feature.
FF4j	create(Feature fp) Create new Feature.
FF4j	create(String featureName) Create new Feature.
FF4j	create(String featureName, boolean enable) Create new Feature.
FF4j	create(String featureName, boolean enable, String description) Create new Feature.
FF4j	delete(String fpId) Delete feature name.
FF4j	disable(String featureID) Disable Feature.
FF4j	disableGroup(String groupName) Disable group.
FF4j	enable(String featureID) Enable Feature.
FF4j	enableGroup(String groupName) Enable group.
boolean	exist(String featureId) Check if target feature exist.
InputStream	exportFeatures() Export Feature through FF4J.
AuthorizationsManager	getAuthorizationsManager() Getter accessor for attribute 'authorizationsManager'.
FlippingExecutionContext	getCurrentContext() Initialize flipping execution context.
EventPublisher	getEventPublisher() Getter accessor for attribute 'eventPublisher'.
EventRepository	getEventRepository() Getter accessor for attribute 'eventRepository'.
Feature	getFeature(String featureID) The feature will be create automatically if the boolea, autocreate is enabled.
Map<String,Feature>	getFeatures() Read Features from store.
FeatureStore	getFeatureStore() Access store as static way (single store).
Map<String,AbstractProperty<?>>	getProperties() Return all properties from store.
PropertyStore	getPropertiesStore() Getter accessor for attribute 'pStore'.
long	getStartTime() Getter accessor for attribute 'startTime'.
FeatureStore	getStore() Deprecated. use getFeatureStore() instead as since 1.4 there are both Features and properties stores
String	getVersion() Getter accessor for attribute 'version'.
boolean	isAllowed(Feature featureName) Load SecurityProvider roles (e.g : SpringSecurity GrantedAuthorities)
boolean	isAutocreate() Getter accessor for attribute 'autocreate'.
boolean	isEnableAudit() Getter accessor for attribute 'enableAudit'.
void	removeCurrentContext() Clear context.
void	setAuthorizationsManager(AuthorizationsManager authorizationsManager) Setter accessor for attribute 'authorizationsManager'.
void	setAutocreate(boolean autocreate) Setter accessor for attribute 'autocreate'.
void	setEnableAudit(boolean enableAudit) Setter accessor for attribute 'enableAudit'.
void	setEventPublisher(EventPublisher eventPublisher) Setter accessor for attribute 'eventPublisher'.
void	setEventRepository(EventRepository eventRepository) Setter accessor for attribute 'eventRepository'.
void	setFeatureStore(FeatureStore fbs) NON Static to be use by Injection of Control.
void	setFileName(String fname) Required for spring namespace and 'fileName' attribut on ff4j tag.
void	setPropertiesStore(PropertyStore pStore) Setter accessor for attribute 'pStore'.
void	setStore(FeatureStore fbs) Deprecated.
void	stop() Shuts down the event publisher if we actually started it (As opposed to having it dependency-injected).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FF4j

public FF4j()

Default constructor to allows instantiation through IoC. The created store is an empty InMemoryFeatureStore.

FF4j

public FF4j(String xmlFile)

Constructor initializing ff4j with an InMemoryStore

FF4j

public FF4j(InputStream xmlFileResourceAsStream)

Constructor initializing ff4j with an InMemoryStore using an InputStream. Simplify integration with Android through Asset

Method Detail

check

public boolean check(String featureID)

Ask if flipped.

Parameters:

featureID - feature unique identifier.

executionContext - current execution context

Returns:

current feature status

check

public boolean check(String featureID,
                     FlippingExecutionContext executionContext)

Elegant way to ask for flipping.

Parameters:

featureID - feature unique identifier.

executionContext - current execution context

Returns:

current feature status

checkOveridingStrategy

public boolean checkOveridingStrategy(String featureID,
                                      FlippingStrategy strats)

Overriding strategy on feature.

Parameters:

featureID - feature unique identifier.

executionContext - current execution context

Returns:

checkOveridingStrategy

public boolean checkOveridingStrategy(String featureID,
                                      FlippingStrategy strats,
                                      FlippingExecutionContext executionContext)

Overriding strategy on feature.

Parameters:

featureID - feature unique identifier.

executionContext - current execution context

Returns:

isAllowed

public boolean isAllowed(Feature featureName)

Load SecurityProvider roles (e.g : SpringSecurity GrantedAuthorities)

Parameters:

featureName - target name of the feature

Returns:

if the feature is allowed

getFeatures

public Map<String,Feature> getFeatures()

Read Features from store.

Returns:

get store features

getProperties

public Map<String,AbstractProperty<?>> getProperties()

Return all properties from store.

Returns:

target property store.

enable

public FF4j enable(String featureID)

Enable Feature.

Parameters:

featureID - unique feature identifier.

enableGroup

public FF4j enableGroup(String groupName)

Enable group.

Parameters:

groupName - target groupeName

Returns:

current instance

disableGroup

public FF4j disableGroup(String groupName)

Disable group.

Parameters:

groupName - target groupeName

Returns:

current instance

create

public FF4j create(Feature fp)

Create new Feature.

Parameters:

featureID - unique feature identifier.

create

public FF4j create(String featureName,
                   boolean enable,
                   String description)

Create new Feature.

Parameters:

featureID - unique feature identifier.

create

public FF4j create(String featureName,
                   boolean enable)

Create new Feature.

Parameters:

featureID - unique feature identifier.

create

public FF4j create(String featureName)

Create new Feature.

Parameters:

featureID - unique feature identifier.

disable

public FF4j disable(String featureID)

Disable Feature.

Parameters:

featureID - unique feature identifier.

exist

public boolean exist(String featureId)

Check if target feature exist.

Parameters:

featureId - unique feature identifier.

Returns:

flag to check existence of

getFeature

public Feature getFeature(String featureID)

The feature will be create automatically if the boolea, autocreate is enabled.

Parameters:

featureID - target feature ID

Returns:

target feature.

exportFeatures

public InputStream exportFeatures()
                           throws IOException

Export Feature through FF4J.

Returns:

Throws:

IOException

autoCreate

public FF4j autoCreate(boolean flag)

Enable autocreation of features when not found.

Parameters:

flag - target value for autocreate flag

Returns:

current instance

delete

public FF4j delete(String fpId)

Delete feature name.

Parameters:

fpId - target feature

toString

public String toString()

Overrides:

toString in class Object

getStore

@Deprecated
public FeatureStore getStore()

Deprecated. use getFeatureStore() instead as since 1.4 there are both Features and properties stores

Access store as static way (single store).

Returns:

current store

getFeatureStore

public FeatureStore getFeatureStore()

Access store as static way (single store).

Returns:

current store

setStore

@Deprecated
public void setStore(FeatureStore fbs)

Deprecated.

NON Static to be use by Injection of Control.

Parameters:

fbs - target store.

setFeatureStore

public void setFeatureStore(FeatureStore fbs)

NON Static to be use by Injection of Control.

Parameters:

fbs - target store.

setAutocreate

public void setAutocreate(boolean autocreate)

Setter accessor for attribute 'autocreate'.

Parameters:

autocreate - new value for 'autocreate '

getAuthorizationsManager

public AuthorizationsManager getAuthorizationsManager()

Getter accessor for attribute 'authorizationsManager'.

Returns:

current value of 'authorizationsManager'

setAuthorizationsManager

public void setAuthorizationsManager(AuthorizationsManager authorizationsManager)

Setter accessor for attribute 'authorizationsManager'.

Parameters:

authorizationsManager - new value for 'authorizationsManager '

getEventRepository

public EventRepository getEventRepository()

Getter accessor for attribute 'eventRepository'.

Returns:

current value of 'eventRepository'

setEventRepository

public void setEventRepository(EventRepository eventRepository)

Setter accessor for attribute 'eventRepository'.

Parameters:

eventRepository - new value for 'eventRepository '

setEventPublisher

public void setEventPublisher(EventPublisher eventPublisher)

Setter accessor for attribute 'eventPublisher'.

Parameters:

eventPublisher - new value for 'eventPublisher '

getEventPublisher

public EventPublisher getEventPublisher()

Getter accessor for attribute 'eventPublisher'.

Returns:

current value of 'eventPublisher'

isAutocreate

public boolean isAutocreate()

Getter accessor for attribute 'autocreate'.

Returns:

current value of 'autocreate'

getStartTime

public long getStartTime()

Getter accessor for attribute 'startTime'.

Returns:

current value of 'startTime'

getVersion

public String getVersion()

Getter accessor for attribute 'version'.

Returns:

current value of 'version'

getPropertiesStore

public PropertyStore getPropertiesStore()

Getter accessor for attribute 'pStore'.

Returns:

current value of 'pStore'

setPropertiesStore

public void setPropertiesStore(PropertyStore pStore)

Setter accessor for attribute 'pStore'.

Parameters:

pStore - new value for 'pStore '

getCurrentContext

public FlippingExecutionContext getCurrentContext()

Initialize flipping execution context.

Returns:

get current context

removeCurrentContext

public void removeCurrentContext()

Clear context.

isEnableAudit

public boolean isEnableAudit()

Getter accessor for attribute 'enableAudit'.

Returns:

current value of 'enableAudit'

setEnableAudit

public void setEnableAudit(boolean enableAudit)

Setter accessor for attribute 'enableAudit'.

Parameters:

enableAudit - new value for 'enableAudit '

setFileName

public void setFileName(String fname)

Required for spring namespace and 'fileName' attribut on ff4j tag.

Parameters:

fname - target name

stop

public void stop()

Shuts down the event publisher if we actually started it (As opposed to having it dependency-injected).