Class TargetingFilter

java.lang.Object
com.azure.spring.cloud.feature.management.filters.TargetingFilter
All Implemented Interfaces:
ContextualFeatureFilter, FeatureFilter
public class TargetingFilter extends Object implements FeatureFilter, ContextualFeatureFilter
`Microsoft.TargetingFilter` enables evaluating a user/group/overall rollout of a feature.

  • Field Details

    • OBJECT_MAPPER

      protected static final ObjectMapper OBJECT_MAPPER
      Object Mapper for converting configurations to features

  • 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.

    • evaluate

      public boolean evaluate(FeatureFilterEvaluationContext context, Object appContext)
      Description copied from interface: ContextualFeatureFilter
      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 ContextualFeatureFilter
      Parameters:
      context - The context for whether or not the filter is passed.
      appContext - The internal app context
      Returns:
      True if the feature is enabled, false otherwise.