org.ff4j.core

Class Feature

java.lang.Object

org.ff4j.core.Feature

All Implemented Interfaces:

Serializable

public class Feature
extends Object
implements Serializable

Represents a feature flag identified by an unique identifier.

Features Flags or Features Toggle have been introduced by Martin Fowler for continuous delivery perspective. It consists of enable/disable some functionalities at runtime.

SecurityManagement : Even a feature is enabled, you can limit its usage to a group of users (for instance BETA Tester) before wide over all your users.

Author:

Cedrick LUNVEN

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Feature(String uid) Simplest constructor initializing feature to disable.
Feature(String uid, boolean penable) Simple constructor initializing feature with status enable/disable.
Feature(String uid, boolean penable, String pdescription) Simplest Constructor (without security concerns)
Feature(String uid, boolean penable, String pdescription, String group) Simplest Constructor (without security concerns)
Feature(String uid, boolean penable, String pdescription, String group, Collection<String> auths) Constructor with limited access roles definitions
Feature(String uid, boolean penable, String pdescription, String group, Collection<String> auths, FlippingStrategy strat) Constructor with limited access roles definitions

Method Summary

Modifier and Type	Method and Description
void	disable() Disable target feature
void	enable() Enable target feature
Map<String,AbstractProperty<?>>	getCustomProperties() Getter accessor for attribute 'customProperties'.
String	getDescription() Getter accessor for attribute 'description'.
FlippingStrategy	getFlippingStrategy() Getter accessor for attribute 'flippingStrategy'.
String	getGroup() Getter accessor for attribute 'group'.
Set<String>	getPermissions() Getter accessor for attribute 'permissions'.
<T> AbstractProperty<T>	getProperty(String propId) Accessor to read a custom property from Feature.
String	getUid() Getter accessor for attribute 'uid'.
boolean	isEnable() Getter accessor for attribute 'enable'.
void	setCustomProperties(Map<String,AbstractProperty<?>> customProperties) Setter accessor for attribute 'customProperties'.
void	setDescription(String description) Setter accessor for attribute 'description'.
void	setEnable(boolean enable) Setter accessor for attribute 'enable'.
void	setFlippingStrategy(FlippingStrategy flippingStrategy) Setter accessor for attribute 'flippingStrategy'.
void	setGroup(String group) Setter accessor for attribute 'group'.
void	setPermissions(Set<String> permissions) Setter accessor for attribute 'permissions'.
void	setUid(String uid) Setter accessor for attribute 'uid'.
void	toggle() Toggle target feature (from enable to disable and vice versa)
String	toJson() Convert Feature to JSON.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Feature

public Feature(String uid)

Simplest constructor initializing feature to disable.

Parameters:

uid - unique feature name (required)

Feature

public Feature(String uid,
               boolean penable)

Simple constructor initializing feature with status enable/disable.

Parameters:

uid - unique feature name (required)

penable - initial feature state

Feature

public Feature(String uid,
               boolean penable,
               String pdescription)

Simplest Constructor (without security concerns)

Parameters:

uid - unique feature name (required)

penable - initial feature state

pdescription - description of feature.

Feature

public Feature(String uid,
               boolean penable,
               String pdescription,
               String group)

Simplest Constructor (without security concerns)

Parameters:

uid - unique feature name (required)

penable - initial feature state

pdescription - description of feature.

Feature

public Feature(String uid,
               boolean penable,
               String pdescription,
               String group,
               Collection<String> auths)

Constructor with limited access roles definitions

Parameters:

uid - unique feature name (required)

penable - initial feature state

pdescription - description of feature.

auths - limited roles to use the feature even if enabled

Feature

public Feature(String uid,
               boolean penable,
               String pdescription,
               String group,
               Collection<String> auths,
               FlippingStrategy strat)

Constructor with limited access roles definitions

Parameters:

uid - unique feature name (required)

penable - initial feature state

pdescription - description of feature.

auths - limited roles to use the feature even if enabled

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Convert Feature to JSON.

Returns:

target json

enable

public void enable()

Enable target feature

disable

public void disable()

Disable target feature

toggle

public void toggle()

Toggle target feature (from enable to disable and vice versa)

getUid

public String getUid()

Getter accessor for attribute 'uid'.

Returns:

current value of 'uid'

setUid

public void setUid(String uid)

Setter accessor for attribute 'uid'.

Parameters:

uid - new value for 'uid '

isEnable

public boolean isEnable()

Getter accessor for attribute 'enable'.

Returns:

current value of 'enable'

setEnable

public void setEnable(boolean enable)

Setter accessor for attribute 'enable'.

Parameters:

enable - new value for 'enable '

getDescription

public String getDescription()

Getter accessor for attribute 'description'.

Returns:

current value of 'description'

setDescription

public void setDescription(String description)

Setter accessor for attribute 'description'.

Parameters:

description - new value for 'description '

getFlippingStrategy

public FlippingStrategy getFlippingStrategy()

Getter accessor for attribute 'flippingStrategy'.

Returns:

current value of 'flippingStrategy'

setFlippingStrategy

public void setFlippingStrategy(FlippingStrategy flippingStrategy)

Setter accessor for attribute 'flippingStrategy'.

Parameters:

flippingStrategy - new value for 'flippingStrategy '

getGroup

public String getGroup()

Getter accessor for attribute 'group'.

Returns:

current value of 'group'

setGroup

public void setGroup(String group)

Setter accessor for attribute 'group'.

Parameters:

group - new value for 'group '

getPermissions

public Set<String> getPermissions()

Getter accessor for attribute 'permissions'.

Returns:

current value of 'permissions'

setPermissions

public void setPermissions(Set<String> permissions)

Setter accessor for attribute 'permissions'.

Parameters:

permissions - new value for 'permissions '

getProperty

public <T> AbstractProperty<T> getProperty(String propId)

Accessor to read a custom property from Feature.

Parameters:

propId - property

Returns:

property value (if exist)

getCustomProperties

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

Getter accessor for attribute 'customProperties'.

Returns:

current value of 'customProperties'

setCustomProperties

public void setCustomProperties(Map<String,AbstractProperty<?>> customProperties)

Setter accessor for attribute 'customProperties'.

Parameters:

customProperties - new value for 'customProperties '