Skip to content

Latest commit

 

History

History
104 lines (79 loc) · 5.85 KB

README.md

File metadata and controls

104 lines (79 loc) · 5.85 KB
Raw

Split OpenFeature Provider for Java

Twitter Follow

Overview

This Provider is designed to allow the use of OpenFeature with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.

Compatibility

This SDK is compatible with Java 11 and higher.

Getting started

Add it to your maven build

<dependency>
    <groupId>io.split.openfeature</groupId>
    <artifactId>split-openfeature-provider</artifactId>
    <version>1.1.0</version>
</dependency>

Configure it

Below is a simple example that describes the instantiation of the Split Provider. Please see the OpenFeature Documentation for details on how to use the OpenFeature SDK.

import dev.openfeature.sdk.OpenFeatureAPI;
import io.split.openfeature.SplitProvider;

OpenFeatureAPI api = OpenFeatureAPI.getInstance();
api.setProvider(new SplitProvider("YOUR_API_KEY"));

If you are more familiar with Split or want access to other initialization options, you can provide a SplitClient to the constructor. See the Split Java SDK Documentation for more information.

import dev.openfeature.sdk.OpenFeatureAPI;
import io.split.openfeature.SplitProvider;
import io.split.client.SplitClient;
import io.split.client.SplitClientConfig;
import io.split.client.SplitFactoryBuilder;

OpenFeatureAPI api = OpenFeatureAPI.getInstance();


SplitClientConfig config = SplitClientConfig.builder()
   .setBlockUntilReadyTimeout(10000)
   .build();
SplitClient splitClient = SplitFactoryBuilder.build("YOUR_API_KEY", config).client();
api.setProvider(new SplitProvider(splitClient));

Use of OpenFeature with Split

After the initial setup you can use OpenFeature according to their documentation.

One important note is that the Split Provider requires a targeting key to be set. Often times this should be set when evaluating the value of a flag by setting an EvaluationContext which contains the targeting key. An example flag evaluation is

Client client = api.getClient("CLIENT_NAME");

EvaluationContext context = new MutableContext("TARGETING_KEY");
Boolean boolValue = client.getBooleanValue("boolFlag", false, context);

If the same targeting key is used repeatedly, the evaluation context may be set at the client level

EvaluationContext context = new MutableContext("TARGETING_KEY");
client.setEvaluationContext(context)

or at the OpenFeatureAPI level

EvaluationContext context = new MutableContext("TARGETING_KEY");
OpenFeatureAPI.getInstance().setEvaluationContext(context)

If the context was set at the client or api level, it is not required to provide it during flag evaluation.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact [email protected], or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.