DocumentationAPI ReferenceSupport
Documentation
Sign In

Java Provider

Suggest Edits

Get Started

An OpenFeature Provider is a pluggable integration layer that connects the OpenFeature SDK to a specific feature flag management system (e.g., VWO or custom in-house solutions). OpenFeature is an open-source standard for feature flagging, designed to provide a vendor-agnostic approach, enabling organizations to switch between feature flagging tools without rewriting application code.

This VWO Openfeature Provider for Java helps you integrate feature management and experimentation systems within your Java based server applications.

ResourceLink
GitHub repositoryhttps://github.com/wingify/vwo-openfeature-provider-java
Published on
Openfeature Java docshttps://openfeature.dev/docs/reference/technologies/server/java

🚧

Please Note

This library is intended to be used in server-side contexts and has not been evaluated for use on mobile devices.

Requirements

The Java SDK supports:

  • Open JDK - 8 onwards
  • Oracle JDK - 8 onwards

SDK Installation

Install dependencies using mvn install

Add below Maven dependency in your project.

<dependency>
    <groupId>com.vwo.sdk</groupId>
    <artifactId>vwo-openfeature-provider-java</artifactId>
    <version>LATEST</version>
</dependency>

Usage

import dev.openfeature.sdk.*;
import com.vwo.VWOProvider;
import java.util.Map;

OpenFeatureAPI api = OpenFeatureAPI.getInstance();

Map<String, Object> options = new HashMap<>();
options.put("accountId", 1234);
options.put("sdkKey", "32-alpha-numeric-sdk-key");

api.setProvider(new VWOProvider(vwoClient));

EvaluationContext context = new ImmutableContext(new HashMap() {
       {
           put("userId", new Value("user1")); // userId
           put("key", new Value("variableKey")); // variable key
           put("customVariables", new Value(new ImmutableContext(new HashMap() {
               {
                   put("key", new Value("value"));
               }
           })));
       }
});

Client vwoClient = api.getClient("vwo-openfeature-provider-java-provider");
apiClient.getStringValue("featureKey", "defaultValue", context)

API Details

APIArgumentsArgument DescriptionAPI Description
new VWOProvider(vwoClient)vwoClient (VWO SDK instance)vwoClient: The initialized VWO SDK client instance.Creates a new instance of VWOProvider, which integrates VWO with OpenFeature.
OpenFeature.setProvider(provider)provider (Instance of VWOProvider)provider: The VWO provider instance that will handle feature flag evaluations.Sets the provider for OpenFeature, enabling it to evaluate feature flags using VWO.
client.setContext(context)context: objectcontext: Contains user details (e.g., { user: { id: 'unique-user-id' } }).Sets the evaluation context for feature flag evaluations, helping with user-based targeting.
client.getBooleanValuefeatureKey: string, defaultValue: boolean, context: objectfeatureKey: The unique key representing the feature flag.
defaultValue: The fallback boolean value if the flag evaluation fails.
context: The evaluation context containing user details and an optional key to fetch a specific variable.		Fetches the boolean value of a feature flag. If key is present in context, it retrieves a specific variable; otherwise, it returns whether the feature is enabled.
client.getStringValuefeatureKey: string, defaultValue: string, context: objectfeatureKey: The unique key representing the feature flag.
defaultValue: The fallback string value if the flag evaluation fails.
context: The evaluation context with user details and optional key to fetch a specific variable.		Fetches the string value of a feature flag. Requires key in context to return a specific variable's value; otherwise, returns undefined.
client.getNumberValuefeatureKey: string, defaultValue: number, context: objectfeatureKey: The unique key representing the feature flag.
defaultValue: The fallback numeric value if the flag evaluation fails.
context: The evaluation context with user details and optional key to fetch a specific variable.		Fetches the numeric value of a feature flag. Requires key in context to return a specific variable's value; otherwise, returns undefined.
client.getObjectValuefeatureKey: string, defaultValue: object, context: objectfeatureKey: The unique key representing the feature flag.
defaultValue: The fallback JSON object if the flag evaluation fails.
context: The evaluation context with user details and optional key to fetch a specific variable.		Fetches the JSON object value of a feature flag. If key is provided in context, it retrieves a specific variable value; otherwise, it returns all JSON variables.

Updated 14 days ago