dev.openfeature.sdk

Class OpenFeatureClient

java.lang.Object

dev.openfeature.sdk.OpenFeatureClient

All Implemented Interfaces:

Client, EventBus<Client>, Features

public class OpenFeatureClient
extends Object
implements Client

Constructor Summary

Constructors

Constructor and Description
OpenFeatureClient(OpenFeatureAPI openFeatureAPI, String name, String version) Deprecated. Do not use this constructor. It's for internal use only. Clients created using it will not run event handlers. Use the OpenFeatureAPI's getClient factory method instead.

Method Summary

Modifier and Type	Method and Description
void	addHooks(Hook... hooks) Adds hooks for evaluation.
FlagEvaluationDetails<Boolean>	getBooleanDetails(String key, Boolean defaultValue)
FlagEvaluationDetails<Boolean>	getBooleanDetails(String key, Boolean defaultValue, EvaluationContext ctx)
FlagEvaluationDetails<Boolean>	getBooleanDetails(String key, Boolean defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Boolean	getBooleanValue(String key, Boolean defaultValue)
Boolean	getBooleanValue(String key, Boolean defaultValue, EvaluationContext ctx)
Boolean	getBooleanValue(String key, Boolean defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
FlagEvaluationDetails<Double>	getDoubleDetails(String key, Double defaultValue)
FlagEvaluationDetails<Double>	getDoubleDetails(String key, Double defaultValue, EvaluationContext ctx)
FlagEvaluationDetails<Double>	getDoubleDetails(String key, Double defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Double	getDoubleValue(String key, Double defaultValue)
Double	getDoubleValue(String key, Double defaultValue, EvaluationContext ctx)
Double	getDoubleValue(String key, Double defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
EvaluationContext	getEvaluationContext() Return an optional client-level evaluation context.
List<Hook>	getHooks() Fetch the hooks associated to this client.
FlagEvaluationDetails<Integer>	getIntegerDetails(String key, Integer defaultValue)
FlagEvaluationDetails<Integer>	getIntegerDetails(String key, Integer defaultValue, EvaluationContext ctx)
FlagEvaluationDetails<Integer>	getIntegerDetails(String key, Integer defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Integer	getIntegerValue(String key, Integer defaultValue)
Integer	getIntegerValue(String key, Integer defaultValue, EvaluationContext ctx)
Integer	getIntegerValue(String key, Integer defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Metadata	getMetadata()
FlagEvaluationDetails<Value>	getObjectDetails(String key, Value defaultValue)
FlagEvaluationDetails<Value>	getObjectDetails(String key, Value defaultValue, EvaluationContext ctx)
FlagEvaluationDetails<Value>	getObjectDetails(String key, Value defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Value	getObjectValue(String key, Value defaultValue)
Value	getObjectValue(String key, Value defaultValue, EvaluationContext ctx)
Value	getObjectValue(String key, Value defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
FlagEvaluationDetails<String>	getStringDetails(String key, String defaultValue)
FlagEvaluationDetails<String>	getStringDetails(String key, String defaultValue, EvaluationContext ctx)
FlagEvaluationDetails<String>	getStringDetails(String key, String defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
String	getStringValue(String key, String defaultValue)
String	getStringValue(String key, String defaultValue, EvaluationContext ctx)
String	getStringValue(String key, String defaultValue, EvaluationContext ctx, FlagEvaluationOptions options)
Client	on(ProviderEvent event, Consumer<EventDetails> handler) Add a handler for the specified ProviderEvent.
Client	onProviderConfigurationChanged(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.
Client	onProviderError(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_STALE event.
Client	onProviderReady(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_READY event.
Client	onProviderStale(Consumer<EventDetails> handler) Add a handler for the ProviderEvent.PROVIDER_ERROR event.
Client	removeHandler(ProviderEvent event, Consumer<EventDetails> handler) Remove the previously attached handler by reference.
void	setEvaluationContext(EvaluationContext evaluationContext) Set the client-level evaluation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenFeatureClient

@Deprecated
public OpenFeatureClient(OpenFeatureAPI openFeatureAPI,
                                     String name,
                                     String version)

Deprecated. Do not use this constructor. It's for internal use only. Clients created using it will not run event handlers. Use the OpenFeatureAPI's getClient factory method instead.

Deprecated public constructor. Use OpenFeature.API.getClient() instead.

Parameters:

openFeatureAPI - Backing global singleton

name - Name of the client (used by observability tools).

version - Version of the client (used by observability tools).

Method Detail

addHooks

public void addHooks(Hook... hooks)

Adds hooks for evaluation. Hooks are run in the order they're added in the before stage. They are run in reverse order for all other stages.

Specified by:

addHooks in interface Client

Parameters:

hooks - The hook to add.

getHooks

public List<Hook> getHooks()

Fetch the hooks associated to this client.

Specified by:

getHooks in interface Client

Returns:

A list of Hooks.

setEvaluationContext

public void setEvaluationContext(EvaluationContext evaluationContext)

Set the client-level evaluation context.

Specified by:

setEvaluationContext in interface Client

Parameters:

evaluationContext - Client level context.

getEvaluationContext

public EvaluationContext getEvaluationContext()

Return an optional client-level evaluation context.

Specified by:

getEvaluationContext in interface Client

Returns:

EvaluationContext

getBooleanValue

public Boolean getBooleanValue(String key,
                               Boolean defaultValue)

Specified by:

getBooleanValue in interface Features

getBooleanValue

public Boolean getBooleanValue(String key,
                               Boolean defaultValue,
                               EvaluationContext ctx)

Specified by:

getBooleanValue in interface Features

getBooleanValue

public Boolean getBooleanValue(String key,
                               Boolean defaultValue,
                               EvaluationContext ctx,
                               FlagEvaluationOptions options)

Specified by:

getBooleanValue in interface Features

getBooleanDetails

public FlagEvaluationDetails<Boolean> getBooleanDetails(String key,
                                                        Boolean defaultValue)

Specified by:

getBooleanDetails in interface Features

getBooleanDetails

public FlagEvaluationDetails<Boolean> getBooleanDetails(String key,
                                                        Boolean defaultValue,
                                                        EvaluationContext ctx)

Specified by:

getBooleanDetails in interface Features

getBooleanDetails

public FlagEvaluationDetails<Boolean> getBooleanDetails(String key,
                                                        Boolean defaultValue,
                                                        EvaluationContext ctx,
                                                        FlagEvaluationOptions options)

Specified by:

getBooleanDetails in interface Features

getStringValue

public String getStringValue(String key,
                             String defaultValue)

Specified by:

getStringValue in interface Features

getStringValue

public String getStringValue(String key,
                             String defaultValue,
                             EvaluationContext ctx)

Specified by:

getStringValue in interface Features

getStringValue

public String getStringValue(String key,
                             String defaultValue,
                             EvaluationContext ctx,
                             FlagEvaluationOptions options)

Specified by:

getStringValue in interface Features

getStringDetails

public FlagEvaluationDetails<String> getStringDetails(String key,
                                                      String defaultValue)

Specified by:

getStringDetails in interface Features

getStringDetails

public FlagEvaluationDetails<String> getStringDetails(String key,
                                                      String defaultValue,
                                                      EvaluationContext ctx)

Specified by:

getStringDetails in interface Features

getStringDetails

public FlagEvaluationDetails<String> getStringDetails(String key,
                                                      String defaultValue,
                                                      EvaluationContext ctx,
                                                      FlagEvaluationOptions options)

Specified by:

getStringDetails in interface Features

getIntegerValue

public Integer getIntegerValue(String key,
                               Integer defaultValue)

Specified by:

getIntegerValue in interface Features

getIntegerValue

public Integer getIntegerValue(String key,
                               Integer defaultValue,
                               EvaluationContext ctx)

Specified by:

getIntegerValue in interface Features

getIntegerValue

public Integer getIntegerValue(String key,
                               Integer defaultValue,
                               EvaluationContext ctx,
                               FlagEvaluationOptions options)

Specified by:

getIntegerValue in interface Features

getIntegerDetails

public FlagEvaluationDetails<Integer> getIntegerDetails(String key,
                                                        Integer defaultValue)

Specified by:

getIntegerDetails in interface Features

getIntegerDetails

public FlagEvaluationDetails<Integer> getIntegerDetails(String key,
                                                        Integer defaultValue,
                                                        EvaluationContext ctx)

Specified by:

getIntegerDetails in interface Features

getIntegerDetails

public FlagEvaluationDetails<Integer> getIntegerDetails(String key,
                                                        Integer defaultValue,
                                                        EvaluationContext ctx,
                                                        FlagEvaluationOptions options)

Specified by:

getIntegerDetails in interface Features

getDoubleValue

public Double getDoubleValue(String key,
                             Double defaultValue)

Specified by:

getDoubleValue in interface Features

getDoubleValue

public Double getDoubleValue(String key,
                             Double defaultValue,
                             EvaluationContext ctx)

Specified by:

getDoubleValue in interface Features

getDoubleValue

public Double getDoubleValue(String key,
                             Double defaultValue,
                             EvaluationContext ctx,
                             FlagEvaluationOptions options)

Specified by:

getDoubleValue in interface Features

getDoubleDetails

public FlagEvaluationDetails<Double> getDoubleDetails(String key,
                                                      Double defaultValue)

Specified by:

getDoubleDetails in interface Features

getDoubleDetails

public FlagEvaluationDetails<Double> getDoubleDetails(String key,
                                                      Double defaultValue,
                                                      EvaluationContext ctx)

Specified by:

getDoubleDetails in interface Features

getDoubleDetails

public FlagEvaluationDetails<Double> getDoubleDetails(String key,
                                                      Double defaultValue,
                                                      EvaluationContext ctx,
                                                      FlagEvaluationOptions options)

Specified by:

getDoubleDetails in interface Features

getObjectValue

public Value getObjectValue(String key,
                            Value defaultValue)

Specified by:

getObjectValue in interface Features

getObjectValue

public Value getObjectValue(String key,
                            Value defaultValue,
                            EvaluationContext ctx)

Specified by:

getObjectValue in interface Features

getObjectValue

public Value getObjectValue(String key,
                            Value defaultValue,
                            EvaluationContext ctx,
                            FlagEvaluationOptions options)

Specified by:

getObjectValue in interface Features

getObjectDetails

public FlagEvaluationDetails<Value> getObjectDetails(String key,
                                                     Value defaultValue)

Specified by:

getObjectDetails in interface Features

getObjectDetails

public FlagEvaluationDetails<Value> getObjectDetails(String key,
                                                     Value defaultValue,
                                                     EvaluationContext ctx)

Specified by:

getObjectDetails in interface Features

getObjectDetails

public FlagEvaluationDetails<Value> getObjectDetails(String key,
                                                     Value defaultValue,
                                                     EvaluationContext ctx,
                                                     FlagEvaluationOptions options)

Specified by:

getObjectDetails in interface Features

getMetadata

public Metadata getMetadata()

Specified by:

getMetadata in interface Client

onProviderReady

public Client 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<Client>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderConfigurationChanged

public Client 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<Client>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderError

public Client 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<Client>

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderStale

public Client 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<Client>

Parameters:

handler - behavior to add with this event

Returns:

this

on

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

Add a handler for the specified ProviderEvent.

Specified by:

on in interface EventBus<Client>

Parameters:

event - event type

handler - behavior to add with this event

Returns:

this

removeHandler

public Client 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<Client>

Parameters:

event - event type

handler - to be removed

Returns:

this