Package com.azure.spring.cloud.feature.management.filters

Class TargetingFilter

java.lang.Object

com.azure.spring.cloud.feature.management.filters.TargetingFilter

All Implemented Interfaces:

FeatureFilter

public class TargetingFilter
extends Object
implements FeatureFilter

`Microsoft.TargetingFilter` enables evaluating a user/group/overall rollout of a feature.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUDIENCE	Audience in the filter
protected final TargetingContextAccessor	contextAccessor	Accessor for identifying the current user/group when evaluating
protected static final String	EXCLUSION	Audience that always returns false
protected static final String	GROUPS	groups field in the filter
protected static final ObjectMapper	OBJECT_MAPPER	Object Mapper for converting configurations to features
protected final TargetingEvaluationOptions	options	Options for evaluating the filter
protected static final String	OUT_OF_RANGE	Error message for when the total Audience value is greater than 100 percent.
protected static final String	USERS	users field in the filter

Constructor Summary

Constructors

Constructor	Description
TargetingFilter(TargetingContextAccessor contextAccessor)	Filter for targeting a user/group/percentage of users.
TargetingFilter(TargetingContextAccessor contextAccessor, TargetingEvaluationOptions options)	`Microsoft.TargetingFilter` evaluates a user/group/overall rollout of a feature.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(FeatureFilterEvaluationContext context)	Evaluates if the filter is on or off.
protected double	isTargetedPercentage(String contextId)	Computes the percentage that the contextId falls into.

Methods inherited from class java.lang.Object

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

Field Details

USERS

protected static final String USERS

users field in the filter

See Also:

• Constant Field Values

GROUPS

protected static final String GROUPS

groups field in the filter

See Also:

• Constant Field Values

AUDIENCE

protected static final String AUDIENCE

Audience in the filter

See Also:

• Constant Field Values

EXCLUSION

protected static final String EXCLUSION

Audience that always returns false

See Also:

• Constant Field Values

OUT_OF_RANGE

protected static final String OUT_OF_RANGE

Error message for when the total Audience value is greater than 100 percent.

See Also:

• Constant Field Values

OBJECT_MAPPER

protected static final ObjectMapper OBJECT_MAPPER

Object Mapper for converting configurations to features

contextAccessor

protected final TargetingContextAccessor contextAccessor

Accessor for identifying the current user/group when evaluating

options

protected final TargetingEvaluationOptions options

Options for evaluating the filter

Constructor Details

TargetingFilter

public TargetingFilter(TargetingContextAccessor contextAccessor)

Filter for targeting a user/group/percentage of users.

Parameters:

contextAccessor - Accessor for identifying the current user/group when evaluating

TargetingFilter

public TargetingFilter(TargetingContextAccessor contextAccessor,
 TargetingEvaluationOptions options)

`Microsoft.TargetingFilter` evaluates a user/group/overall rollout of a feature.

Parameters:

contextAccessor - Context for evaluating the users/groups.

options - enables customization of the filter.

Method Details

evaluate

public boolean evaluate(FeatureFilterEvaluationContext context)

Description copied from interface: FeatureFilter

Evaluates if the filter is on or off. Returning true results in Feature evaluation ending and returning true. Returning false results in the next Feature evaluation to continue.

Specified by:

evaluate in interface FeatureFilter

Parameters:

context - The context for whether or not the filter is passed.

Returns:

True if the feature is enabled, false otherwise.

isTargetedPercentage

protected double isTargetedPercentage(String contextId)

Computes the percentage that the contextId falls into.

Parameters:

contextId - Id of the context being targeted

Returns:

the bucket value of the context id

Throws:

TargetingException - Unable to create hash of target context