org.togglz.core.activation

Class ScriptEngineActivationStrategy

java.lang.Object

org.togglz.core.activation.ScriptEngineActivationStrategy

All Implemented Interfaces:

ActivationStrategy

public class ScriptEngineActivationStrategy
extends Object
implements ActivationStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static String	PARAM_LANG
static String	PARAM_SCRIPT

Constructor Summary

Constructors

Constructor and Description
ScriptEngineActivationStrategy()

Method Summary

Modifier and Type	Method and Description
String	getId() A unique id for this strategy.
String	getName() A human readable name of the strategy.
Parameter[]	getParameters() Returns the list of configuration parameter definitions for the strategy.
boolean	isActive(FeatureState featureState, FeatureUser user) This method is responsible to decide whether a feature is active or not.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

PARAM_SCRIPT

public static final String PARAM_SCRIPT

See Also:

Constant Field Values

PARAM_LANG

public static final String PARAM_LANG

See Also:

Constant Field Values

Constructor Detail

ScriptEngineActivationStrategy

public ScriptEngineActivationStrategy()

Method Detail

getId

public String getId()

Description copied from interface: ActivationStrategy

A unique id for this strategy. This id is used to persist the selected strategy in the StateRepository.

Specified by:

getId in interface ActivationStrategy

getName

public String getName()

Description copied from interface: ActivationStrategy

A human readable name of the strategy. This name is used to in the admin console to represent the strategy.

Specified by:

getName in interface ActivationStrategy

isActive

public boolean isActive(FeatureState featureState,
                        FeatureUser user)

Description copied from interface: ActivationStrategy

This method is responsible to decide whether a feature is active or not. The implementation can use the custom configuration parameters of the strategy stored in the feature state and information from the currently acting user to find a decision.

Specified by:

isActive in interface ActivationStrategy

Parameters:

featureState - The feature state which represents the current configuration of the feature. The implementation of the method typically uses FeatureState.getParameter(String) to access custom configuration paramater values.

user - The user for which to decide whether the feature is active. May be null if the user could not be identified by the UserProvider.

Returns:

true if the feature should be active, else false

getParameters

public Parameter[] getParameters()

Description copied from interface: ActivationStrategy

Returns the list of configuration parameter definitions for the strategy. Parameters are typically built using a ParameterBuilder class but users can also create custom implementations of the Parameter interface.

Example:

 public Parameter[] getParameters() {
     return new Parameter[] {
             ParameterBuilder.create("country").label("Country Code").matching("[A-Z]+")
     };
 }
 

Specified by:

getParameters in interface ActivationStrategy

See Also:

ParameterBuilder