Flagsmith OpenFeature Java Provider

Flagsmith provides an all-in-one platform for developing, implementing, and managing your feature flags.

Installation

<dependency>
    <groupId>dev.openfeature.contrib.providers</groupId>
    <artifactId>flagsmith</artifactId>
    <version>0.0.10</version>
</dependency>

Usage

The FlagsmithProvider communicates with Flagsmith using the Flagsmith Java SDK. This example shows how to initialize and use the Flagsmith OpenFeature provider:

import dev.openfeature.contrib.providers.flagsmith.FlagsmithProvider;
import dev.openfeature.contrib.providers.flagsmith.FlagsmithProviderOptions;
import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.MutableContext;
import dev.openfeature.sdk.OpenFeatureAPI;

public class FlagsmithExample {
    public static void main(String[] args) {
        FlagsmithProviderOptions options = FlagsmithProviderOptions.builder()
                .apiKey("API_KEY")
                .build();

        FlagsmithProvider provider = new FlagsmithProvider(options);
        OpenFeatureAPI api = OpenFeatureAPI.getInstance();
        api.setProvider(provider);

        // Optional: set a targeting key and traits to use segment and/or identity overrides
        MutableContext evaluationContext = new MutableContext();
        evaluationContext.setTargetingKey("my-identity-id");

        Client client = api.getClient();
        boolean flag = client.getBooleanValue("my-boolean-flag", false, evaluationContext);
        System.out.println(flag);
    }
}

Options can be defined using the FlagsmithProviderOptions builder. Below are all the options:

Option name	Type	Default	Description
apiKey	String		Your API Token. Note that this is either the Environment API key or the Server Side SDK Token
baseUri	String	https://edge.api.flagsmith.com/api/v1/	Override the default Flagsmith API URL if you are self-hosting.
localEvaluation	boolean	false	Controls which mode to run in; local or remote evaluation.
environmentRefreshIntervalSeconds	int	60	Set environment refresh rate when using local evaluation mode
enableAnalytics	boolean	false	Controls whether Flag Analytics data is sent to the Flagsmith API
headers	HashMap<String, String>		Add custom headers which will be sent with each network request to the Flagsmith API.
envFlagsCacheKey	String		Enable in-memory caching for the Flagsmith API.
expireCacheAfterWriteTimeUnit	TimeUnit	TimeUnit.MINUTES	The time unit used for cache expiry after write.
expireCacheAfterWrite	int	-1	The integer time for cache expiry after write.
expireCacheAfterAccessTimeUnit	TimeUnit	TimeUnit.MINUTES	The time unit used for cache expiry after reading.
expireCacheAfterAccess	int	-1	The integer time for cache expiry after reading.
maxCacheSize	int	-1	The maximum size of the cache in MB.
recordCacheStats	boolean	false	Whether cache statistics should be recorded.
connectTimeout	int	2000	The network timeout in milliseconds.
writeTimeout	int	5000	The network timeout in milliseconds when writing.
readTimeout	int	5000	The network timeout in milliseconds when reading.
sslSocketFactory	SSLSocketFactory		Override the sslSocketFactory.
trustManager	X509TrustManager		X509TrustManager used when overriding the sslSocketFactory.
httpInterceptor	Interceptor		Add a custom HTTP interceptor in the form of an okhttp3.Interceptor object.
retries	int	3	Add a custom com.flagsmith.config.Retry object to configure the backoff / retry configuration.
usingBooleanConfigValue	boolean	false	Determines whether to resolve a feature value as a boolean or use the isFeatureEnabled as the flag itself. These values will be false and true respectively.