Package org.togglz.core.activation

Class SystemPropertyActivationStrategy

java.lang.Object

org.togglz.core.activation.AbstractPropertyDrivenActivationStrategy

org.togglz.core.activation.SystemPropertyActivationStrategy

All Implemented Interfaces:

ActivationStrategy

public class SystemPropertyActivationStrategy
extends AbstractPropertyDrivenActivationStrategy
implements ActivationStrategy

ActivationStrategy based on a key value pair system property. To activate, the value of the property must match the string value, not case sensitive.

Created by Chris Kelley on 5/26/16.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID
static String	PARAM_PROPERTY_NAME

Fields inherited from class org.togglz.core.activation.AbstractPropertyDrivenActivationStrategy

PARAM_NAME, PARAM_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
SystemPropertyActivationStrategy()

Method Summary

Modifier and Type	Method	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.
protected String	getPropertyNameParam()
protected String	getPropertyValue(FeatureState featureState, FeatureUser user, String name)	Returns the value of the property with the specified name on which to base the activation of the feature.

Methods inherited from class org.togglz.core.activation.AbstractPropertyDrivenActivationStrategy

getPropertyName, isActive, isActive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.togglz.core.spi.ActivationStrategy

isActive

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

PARAM_PROPERTY_NAME

public static final String PARAM_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

SystemPropertyActivationStrategy

public SystemPropertyActivationStrategy()

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

getPropertyValue

protected String getPropertyValue(FeatureState featureState,
                                  FeatureUser user,
                                  String name)

Description copied from class: AbstractPropertyDrivenActivationStrategy

Returns the value of the property with the specified name on which to base the activation of the feature.

Specified by:

getPropertyValue in class AbstractPropertyDrivenActivationStrategy

Parameters:

featureState - the FeatureState which represents the current configuration of the feature

user - the user for which to decide whether the feature is active (may be null)

name - the name of the property whose value is to be returned

Returns:

The (raw) value of the property with the given name or null if none could be found.

getPropertyNameParam

protected String getPropertyNameParam()

Overrides:

getPropertyNameParam in class AbstractPropertyDrivenActivationStrategy

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

Overrides:

getParameters in class AbstractPropertyDrivenActivationStrategy

See Also:

ParameterBuilder