OpenFeature Provider for Android SDK

Integrate your Android applications with Harness FME using the Android OpenFeature Provider, a standardized, vendor-agnostic feature flagging API. This provider implements the OpenFeature specification and bridges the OpenFeature SDK with the Harness FME Android SDK.

This page walks you through installing, configuring, and using the Android OpenFeature provider to evaluate feature flags in your Android applications.

Prerequisites

Before you begin, ensure you have the following:

A valid Harness FME SDK key for your project
An Android project targeting API Level 21 (Android 5.0 Lollipop) or later
Access to your project's build.gradle or build.gradle.kts file to add the provider dependency

Version compatibility

Component	Minimum Version
Android	API Level 21 (Android 5.0 Lollipop)
`split-openfeature-provider-android`	≥ 1.0.0
OpenFeature Kotlin SDK	≥ 1.0.0

Install the provider and dependencies

Add the Harness FME OpenFeature provider dependency to your application's build.gradle.kts file.

dependencies {
    implementation("io.split.openfeature:split-openfeature-android:1.0.0")
}

Or, if you're using the Groovy DSL (build.gradle):

dependencies {
    implementation 'io.split.openfeature:split-openfeature-android:1.0.0'
}

Initialize the provider

The Harness FME OpenFeature provider requires an Android application Context (for SDK initialization) and your Harness FME SDK Key.

import dev.openfeature.kotlin.sdk.OpenFeatureAPI
import dev.openfeature.kotlin.sdk.ImmutableContext
import io.split.openfeature.android.provider.SplitProvider

// Create provider configuration
val config = SplitProvider.Config(
    applicationContext = applicationContext,
    sdkKey = "YOUR_SDK_KEY"
)

// Create the FME provider
val provider = SplitProvider(config = config)

// Set the provider with an initial context containing a targeting key
val initialContext = ImmutableContext(targetingKey = "user-123")
OpenFeatureAPI.setProvider(provider, initialContext = initialContext)

// Get a client and evaluate flags
val client = OpenFeatureAPI.getClient()
val showNewFeature = client.getBooleanValue("new-feature", false)

Construct an evaluation context

Provide an evaluation context with a targeting key to evaluate flags. The evaluation context passes targeting information such as user IDs, email addresses, or plan types for flag targeting.

For example:

val context = ImmutableContext(
    targetingKey = "user-123",
    attributes = mapOf(
        "email" to Value.String("user@example.com"),
        "age" to Value.Integer(30),
        "plan" to Value.String("premium")
    )
)

val client = OpenFeatureAPI.getClient()
val result = client.getBooleanDetails("premium-feature", false, context)

To set a targeting key during initialization:

val initialContext = ImmutableContext(targetingKey = "user-123")
OpenFeatureAPI.setProvider(provider, initialContext = initialContext)

To change a targeting key at runtime:

val newContext = ImmutableContext(targetingKey = "user-456")
OpenFeatureAPI.setEvaluationContext(newContext)

Observe provider events

The Harness FME OpenFeature provider emits events when provider state changes (for example, when flags update, configuration changes, or errors) occur. You can observe these events to update your application's behavior in real time.

You can enable your application to:

Refresh feature-dependent UI when flags change
Gracefully handle degraded states (i.e., when the provider becomes stale)
Log or alert on configuration or network issues
Control initialization flows based on provider readiness

For example:

import dev.openfeature.kotlin.sdk.events.OpenFeatureProviderEvents
import kotlinx.coroutines.launch

// Observe provider events
lifecycleScope.launch {
    provider.observe().collect { event ->
        when (event) {
            is OpenFeatureProviderEvents.ProviderReady -> {
                // Provider is ready to evaluate flags
                Log.d("Split", "Provider is ready")
            }
            is OpenFeatureProviderEvents.ProviderConfigurationChanged -> {
                // Flag configuration has been updated
                Log.d("Split", "Configuration changed")
            }
            is OpenFeatureProviderEvents.ProviderStale -> {
                // Provider is serving cached data
                Log.d("Split", "Provider is stale")
            }
            is OpenFeatureProviderEvents.ProviderError -> {
                // An error occurred
                Log.e("Split", "Provider error: ${event.error}")
            }
        }
    }
}

Track events

The Harness FME OpenFeature provider supports tracking user actions or conversion events directly from your Android application.

To enable event tracking, your evaluation context must include the following:

A non-empty targetingKey
A TrafficType (for example, "user" or "account")
A non-blank event name

Optionally, you can include:

Optionally, you can include a numeric value (defaults to 0) and additional event properties (prefers primitives such as string, number, boolean, or null). For more information, see Sending Events.

// Set context with trafficType
val context = ImmutableContext(targetingKey = "user-123")
    .withTrafficType("user")

OpenFeatureAPI.setEvaluationContext(context)

// Track an event
val client = OpenFeatureAPI.getClient()
client.track("button_clicked")

// Track with a value
client.track(
    "purchase_completed",
    TrackingEventDetails(value = 99.99)
)

// Track with properties
client.track(
    "page_viewed",
    TrackingEventDetails(
        structure = ImmutableStructure(
            mapOf(
                "page" to Value.String("home"),
                "referrer" to Value.String("google")
            )
        )
    )
)

For more information, go to the Harness FME Android OpenFeature Provider GitHub repository.

Prerequisites​

Version compatibility​

Install the provider and dependencies​

Initialize the provider​

Construct an evaluation context​

Observe provider events​

Track events​