Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AlwaysOnFilter - Class in com.azure.spring.cloud.feature.management.filters
-
A filter that always returns true
- AlwaysOnFilter() - Constructor for class com.azure.spring.cloud.feature.management.filters.AlwaysOnFilter
-
Creates an instance of
AlwaysOnFilter - AUDIENCE - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Audience in the filter
B
- Built-In Feature Filters - Search tag in Overview
- Section
C
- com.azure.spring.cloud.feature.management - package com.azure.spring.cloud.feature.management
-
Package contains classes for accessing and creating Feature Flags, Feature Filters.
- com.azure.spring.cloud.feature.management.filters - package com.azure.spring.cloud.feature.management.filters
-
* Package contains the built-in Feature Filters, which implement
FeatureFilter. - com.azure.spring.cloud.feature.management.models - package com.azure.spring.cloud.feature.management.models
-
Package containing models classes for setting up Feature Flags, Feature Filters.
- com.azure.spring.cloud.feature.management.targeting - package com.azure.spring.cloud.feature.management.targeting
-
Package containing models classes for targeting user and groups with the targeting filter.
- configureTargetingContext(TargetingContext) - Method in interface com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor
-
Configures the Targeting Context for Feature Targeting evaluation.
- Consumption - Search tag in Overview
- Section
- contextAccessor - Variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Accessor for identifying the current user/group when evaluating
- Controllers - Search tag in Overview
- Section
D
- Disabled Action Handling - Search tag in Overview
- Section
E
- evaluate(FeatureFilterEvaluationContext) - Method in class com.azure.spring.cloud.feature.management.filters.AlwaysOnFilter
- evaluate(FeatureFilterEvaluationContext) - Method in interface com.azure.spring.cloud.feature.management.filters.FeatureFilter
-
Evaluates if the filter is on or off.
- evaluate(FeatureFilterEvaluationContext) - Method in class com.azure.spring.cloud.feature.management.filters.PercentageFilter
-
Performs a percentage based evaluation to determine whether a feature is enabled.
- evaluate(FeatureFilterEvaluationContext) - Method in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
- evaluate(FeatureFilterEvaluationContext) - Method in class com.azure.spring.cloud.feature.management.filters.TimeWindowFilter
-
Evaluates whether a feature is enabled based on a configurable time window.
- EXCLUSION - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Audience that always returns false
F
- Feature Check - Search tag in Overview
- Section
- FeatureFilter - Interface in com.azure.spring.cloud.feature.management.filters
-
A Filter for Feature Management that is attached to Features.
- FeatureFilterEvaluationContext - Class in com.azure.spring.cloud.feature.management.models
-
Context passed into Feature Filters used for evaluation.
- FeatureFilterEvaluationContext() - Constructor for class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Creates an instance of
FeatureFilterEvaluationContext - Feature Filters - Search tag in Overview
- Section
- Feature Flag Declaration - Search tag in Overview
- Section
- Feature Flags - Search tag in Overview
- Section
- Feature Management - Search tag in Overview
- Section
- FeatureManagementException - Exception Class in com.azure.spring.cloud.feature.management.models
-
This class defines a custom exception type for when an expected Filter is not found when checking if a Feature is enabled.
- FeatureManager - Class in com.azure.spring.cloud.feature.management
-
Holds information on Feature Management properties and can check if a given feature is enabled.
- FilterNotFoundException - Exception Class in com.azure.spring.cloud.feature.management.models
-
This class defines a custom exception type for when an expected Filter is not found when checking if a Feature is enabled.
- FilterNotFoundException(String, Throwable, FeatureFilterEvaluationContext) - Constructor for exception class com.azure.spring.cloud.feature.management.models.FilterNotFoundException
-
Creates a new instance of the FilterNotFoundException
- FilterParameters - Class in com.azure.spring.cloud.feature.management.models
-
Parameters for the predefined filters.
G
- getAllFeatureNames() - Method in class com.azure.spring.cloud.feature.management.FeatureManager
-
Returns the names of all features flags
- getFeatureName() - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Return the featureName
- getGroups() - Method in interface com.azure.spring.cloud.feature.management.targeting.TargetingContext
-
Return the groups
- getGroups() - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingFilterContext
- getMessage() - Method in exception class com.azure.spring.cloud.feature.management.models.FeatureManagementException
- getMessage() - Method in exception class com.azure.spring.cloud.feature.management.models.FilterNotFoundException
- getName() - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Return the name
- getParameters() - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Return the parameters
- getUserId() - Method in interface com.azure.spring.cloud.feature.management.targeting.TargetingContext
-
Return the userId
- getUserId() - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingFilterContext
- GROUPS - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
groups field in the filter
I
- Implementing a Feature Filter - Search tag in Overview
- Section
- isEnabled(String) - Method in class com.azure.spring.cloud.feature.management.FeatureManager
-
Checks to see if the feature is enabled.
- isEnabledAsync(String) - Method in class com.azure.spring.cloud.feature.management.FeatureManager
-
Checks to see if the feature is enabled.
- isIgnoreCase() - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions
-
Ignore case of users/groups
- isTargetedPercentage(String) - Method in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Computes the percentage that the contextId falls into.
O
- OBJECT_MAPPER - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Object Mapper for converting configurations to features
- options - Variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Options for evaluating the filter
- OUT_OF_RANGE - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Error message for when the total Audience value is greater than 100 percent.
P
- Parameterized Feature Filters - Search tag in Overview
- Section
- PERCENTAGE_FILTER_SETTING - Static variable in class com.azure.spring.cloud.feature.management.models.FilterParameters
-
Percentage value of the returning true in the Percentage filter.
- PercentageFilter - Search tag in Overview
- Section
- PercentageFilter - Class in com.azure.spring.cloud.feature.management.filters
-
A feature filter that can be used to activate a feature based on a random percentage.
- PercentageFilter() - Constructor for class com.azure.spring.cloud.feature.management.filters.PercentageFilter
-
Creates an instance of
PercentageFilter
R
- Recurrence Pattern - Search tag in Overview
- Section
- Recurrence Range - Search tag in Overview
- Section
- Registration - Search tag in Overview
- Section
- Request Based Features/Snapshot - Search tag in Overview
- Section
- Routing - Search tag in Overview
- Section
S
- setFeatureName(String) - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Set the featureName
- setGroups(List<String>) - Method in interface com.azure.spring.cloud.feature.management.targeting.TargetingContext
-
Set the groups
- setGroups(List<String>) - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingFilterContext
- setIgnoreCase(boolean) - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions
-
Enables ignoring case of users/groups in the Targeting Filter.
- setName(String) - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Set the name
- setParameters(Map<String, Object>) - Method in class com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext
-
Set the parameters
- setUserId(String) - Method in interface com.azure.spring.cloud.feature.management.targeting.TargetingContext
-
Set the userId
- setUserId(String) - Method in class com.azure.spring.cloud.feature.management.targeting.TargetingFilterContext
- Spring Cloud for Azure feature management client library for Java - Search tag in Overview
- Section
- Supported properties - Search tag in Overview
- Section
T
- Targeting - Search tag in Overview
- Section
- TargetingContext - Interface in com.azure.spring.cloud.feature.management.targeting
-
Interface for the Targeting Context used in evaluating the `Microsoft.TargetingFilter`.
- TargetingContextAccessor - Interface in com.azure.spring.cloud.feature.management.targeting
-
Interface for providing a Targeting Context to the `Microsoft.TargetingFilter`.
- TargetingEvaluationOptions - Class in com.azure.spring.cloud.feature.management.targeting
-
Configuration options for the `Microsoft.TargetingFilter`.
- TargetingEvaluationOptions() - Constructor for class com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions
-
Creates an instance of
TargetingEvaluationOptions - Targeting Evaluation Options - Search tag in Overview
- Section
- TargetingException - Exception Class in com.azure.spring.cloud.feature.management.models
-
This class defines a custom exception type for when an expected Filter is not found when checking if a Feature is enabled.
- TargetingException(String) - Constructor for exception class com.azure.spring.cloud.feature.management.models.TargetingException
-
TargetingException for the Targeting Filter.
- TargetingException(String, Throwable) - Constructor for exception class com.azure.spring.cloud.feature.management.models.TargetingException
-
Creates a new instance of the FilterNotFoundException
- TargetingFilter - Search tag in Overview
- Section
- TargetingFilter - Class in com.azure.spring.cloud.feature.management.filters
-
`Microsoft.TargetingFilter` enables evaluating a user/group/overall rollout of a feature.
- TargetingFilter(TargetingContextAccessor) - Constructor for class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
Filter for targeting a user/group/percentage of users.
- TargetingFilter(TargetingContextAccessor, TargetingEvaluationOptions) - Constructor for class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
`Microsoft.TargetingFilter` evaluates a user/group/overall rollout of a feature.
- TargetingFilterContext - Class in com.azure.spring.cloud.feature.management.targeting
-
Context for evaluating the `Microsoft.TargetingFilter`.
- TargetingFilterContext() - Constructor for class com.azure.spring.cloud.feature.management.targeting.TargetingFilterContext
-
Creates an instance of
TargetingFilterContext - Targeting in an Application - Search tag in Overview
- Section
- TIME_WINDOW_FILTER_SETTING_END - Static variable in class com.azure.spring.cloud.feature.management.models.FilterParameters
-
Property for the end of the Time Window Filter
- TIME_WINDOW_FILTER_SETTING_RECURRENCE - Static variable in class com.azure.spring.cloud.feature.management.models.FilterParameters
-
Add-on recurrence rule allows the time window defined by Start and End to recur.
- TIME_WINDOW_FILTER_SETTING_START - Static variable in class com.azure.spring.cloud.feature.management.models.FilterParameters
-
Property for the start of the Time Window Filter
- TimeWindowFilter - Search tag in Overview
- Section
- TimeWindowFilter - Class in com.azure.spring.cloud.feature.management.filters
-
A feature filter that can be used at activate a feature based on a time window.
- TimeWindowFilter() - Constructor for class com.azure.spring.cloud.feature.management.filters.TimeWindowFilter
-
Creates an instance of
TimeWindowFilter
U
- USERS - Static variable in class com.azure.spring.cloud.feature.management.filters.TargetingFilter
-
users field in the filter
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form