Method Detail

• setProvider

   final Unit setProvider(FeatureProvider provider, CoroutineDispatcher dispatcher, EvaluationContext initialContext)

  Set the FeatureProvider for the SDK. This method will return immediately and initialize the provider in a coroutine scope When the provider is successfully initialized it will set the status to Ready. If the provider fails to initialize it will set the status to Error.

  This method requires you to manually wait for the status to be Ready before using the SDK for flag evaluations. This can be done by using the statusFlow and waiting for the first Ready status or by accessing getStatus

  Parameters:

  provider - the provider to set

  dispatcher - the dispatcher to use for the provider initialization coroutine.

  initialContext - the initial EvaluationContext to use for the provider initialization.

• setProviderAndWait

   final Unit setProviderAndWait(FeatureProvider provider, EvaluationContext initialContext, CoroutineDispatcher dispatcher)

  Set the FeatureProvider for the SDK. This method will block until the provider is initialized.

  Parameters:

  provider - the FeatureProvider to set

  initialContext - the initial EvaluationContext to use for the provider initialization.

• getProvider

   final FeatureProvider getProvider()

  Get the current FeatureProvider for the SDK.

• clearProvider

   final Unit clearProvider()

  Clear the current FeatureProvider for the SDK and set it to a no-op provider.

• setEvaluationContextAndWait

   final Unit setEvaluationContextAndWait(EvaluationContext evaluationContext)

  Set the EvaluationContext for the SDK. This method will block until the context is set and the provider is ready.

  If the new context is different compare to the old context, this will cause the provider to reconcile with the new context. When the provider "Reconciles" it will set the status to OpenFeatureStatus.Reconciling. When the provider successfully reconciles it will set the status to OpenFeatureStatus.Ready. If the provider fails to reconcile it will set the status to OpenFeatureStatus.Error.

  Parameters:

  evaluationContext - the EvaluationContext to set

• setEvaluationContext

   final Unit setEvaluationContext(EvaluationContext evaluationContext, CoroutineDispatcher dispatcher)

  Set the EvaluationContext for the SDK. This method will return immediately and set the context in a coroutine scope.

  If the new context is different compare to the old context, this will cause the provider to reconcile with the new context. When the provider "Reconciles" it will set the status to OpenFeatureStatus.Reconciling. When the provider successfully reconciles it will set the status to OpenFeatureStatus.Ready. If the provider fails to reconcile it will set the status to OpenFeatureStatus.Error.

  This method requires you to manually wait for the status to be Ready before using the SDK for flag evaluations. This can be done by using the statusFlow and waiting for the first Ready status or by accessing getStatus

  Parameters:

  evaluationContext - the EvaluationContext to set

• getEvaluationContext

   final EvaluationContext getEvaluationContext()

  Get the current EvaluationContext for the SDK.

• getProviderMetadata

   final ProviderMetadata getProviderMetadata()

  Get the ProviderMetadata for the current FeatureProvider.

• getClient

   final Client getClient(String name, String version)

  Get a Client for the SDK. This client can be used to evaluate flags.

• addHooks

   final Unit addHooks(List<Hook<?>> hooks)

  Add Hooks to the SDK.

• clearHooks

   final Unit clearHooks()

  Clear all Hooks from the SDK.

• shutdown

   final Unit shutdown()

  Shutdown the SDK. This will cancel the provider set job and call the provider's shutdown method. The SDK status will be set to OpenFeatureStatus.NotReady.

• getStatus

   final OpenFeatureStatus getStatus()

  Get the current OpenFeatureStatus of the SDK.

• observe

   final <T extends OpenFeatureProviderEvents> Flow<T> observe()

  Observe events from currently configured Provider.

• getProvidersFlow

   final MutableStateFlow<FeatureProvider> getProvidersFlow()

• getStatusFlow

   final Flow<OpenFeatureStatus> getStatusFlow()

• getHooks

   final List<Hook<?>> getHooks()

• setHooks

   final Unit setHooks(List<Hook<?>> hooks)