dev.openfeature.sdk

Class OpenFeatureAPI

java.lang.Object

dev.openfeature.sdk.OpenFeatureAPI

All Implemented Interfaces:

EventBus<OpenFeatureAPI>

public class OpenFeatureAPI
extends Object
implements EventBus<OpenFeatureAPI>

A global singleton which holds base configuration for the OpenFeature library. Configuration here will be shared across all Clients.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenFeatureAPI()

Method Summary

Modifier and Type	Method and Description
void	addHooks(Hook... hooks)
void	clearHooks()
Client	getClient()
Client	getClient(String name)
Client	getClient(String name, String version)
EvaluationContext	getEvaluationContext()
List<Hook>	getHooks()
static OpenFeatureAPI	getInstance() Provisions the OpenFeatureAPI singleton (if needed) and returns it.
FeatureProvider	getProvider() Return the default provider.
FeatureProvider	getProvider(String name) Fetch a provider for a named client.
Metadata	getProviderMetadata()
Metadata	getProviderMetadata(String clientName)
OpenFeatureAPI	on(ProviderEvent event, Consumer<EventDetails> handler) Add a handler for the specified ProviderEvent.
OpenFeatureAPI	onProviderConfigurationChanged(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.
OpenFeatureAPI	onProviderError(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_STALE event.
OpenFeatureAPI	onProviderReady(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_READY event.
OpenFeatureAPI	onProviderStale(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_ERROR event.
OpenFeatureAPI	removeHandler(ProviderEvent event, Consumer<EventDetails> handler) Remove the previously attached handler by reference.
void	setEvaluationContext(EvaluationContext evaluationContext)
void	setProvider(FeatureProvider provider) Set the default provider.
void	setProvider(String clientName, FeatureProvider provider) Add a provider for a named client.
void	setProviderAndWait(FeatureProvider provider) Set the default provider and wait for initialization to finish.
void	setProviderAndWait(String clientName, FeatureProvider provider) Add a provider for a named client and wait for initialization to finish.
void	shutdown() Shut down and reset the current status of OpenFeature API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenFeatureAPI

protected OpenFeatureAPI()

Method Detail

getInstance

public static OpenFeatureAPI getInstance()

Provisions the OpenFeatureAPI singleton (if needed) and returns it.

Returns:

The singleton instance.

getProviderMetadata

public Metadata getProviderMetadata()

getProviderMetadata

public Metadata getProviderMetadata(String clientName)

getClient

public Client getClient()

getClient

public Client getClient(@Nullable
                        String name)

getClient

public Client getClient(@Nullable
                        String name,
                        @Nullable
                        String version)

setEvaluationContext

public void setEvaluationContext(EvaluationContext evaluationContext)

getEvaluationContext

public EvaluationContext getEvaluationContext()

setProvider

public void setProvider(FeatureProvider provider)

Set the default provider.

setProvider

public void setProvider(String clientName,
                        FeatureProvider provider)

Add a provider for a named client.

Parameters:

clientName - The name of the client.

provider - The provider to set.

setProviderAndWait

public void setProviderAndWait(FeatureProvider provider)

Set the default provider and wait for initialization to finish.

setProviderAndWait

public void setProviderAndWait(String clientName,
                               FeatureProvider provider)

Add a provider for a named client and wait for initialization to finish.

Parameters:

clientName - The name of the client.

provider - The provider to set.

getProvider

public FeatureProvider getProvider()

Return the default provider.

getProvider

public FeatureProvider getProvider(String name)

Fetch a provider for a named client. If not found, return the default.

Parameters:

name - The client name to look for.

Returns:

A named FeatureProvider

addHooks

public void addHooks(Hook... hooks)

getHooks

public List<Hook> getHooks()

clearHooks

public void clearHooks()

shutdown

public void shutdown()

Shut down and reset the current status of OpenFeature API. This call cleans up all active providers and attempts to shut down internal event handling mechanisms. Once shut down is complete, API is reset and ready to use again.

onProviderReady

public OpenFeatureAPI onProviderReady(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_READY event. Shorthand for EventBus.on(ProviderEvent, Consumer)

Specified by:

onProviderReady in interface EventBus<OpenFeatureAPI>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderConfigurationChanged

public OpenFeatureAPI onProviderConfigurationChanged(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event. Shorthand for EventBus.on(ProviderEvent, Consumer)

Specified by:

onProviderConfigurationChanged in interface EventBus<OpenFeatureAPI>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderStale

public OpenFeatureAPI onProviderStale(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_ERROR event. Shorthand for EventBus.on(ProviderEvent, Consumer)

Specified by:

onProviderStale in interface EventBus<OpenFeatureAPI>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderError

public OpenFeatureAPI onProviderError(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_STALE event. Shorthand for EventBus.on(ProviderEvent, Consumer)

Specified by:

onProviderError in interface EventBus<OpenFeatureAPI>

Parameters:

handler - behavior to add with this event

Returns:

this

on

public OpenFeatureAPI on(ProviderEvent event,
                         Consumer<EventDetails> handler)

Add a handler for the specified ProviderEvent.

Specified by:

on in interface EventBus<OpenFeatureAPI>

Parameters:

event - event type

handler - behavior to add with this event

Returns:

this

removeHandler

public OpenFeatureAPI removeHandler(ProviderEvent event,
                                    Consumer<EventDetails> handler)

Remove the previously attached handler by reference. If the handler doesn't exists, no-op.

Specified by:

removeHandler in interface EventBus<OpenFeatureAPI>

Parameters:

event - event type

handler - to be removed

Returns:

this