com.configcat

Class ConfigCatClient

java.lang.Object

com.configcat.ConfigCatClient

All Implemented Interfaces:

ConfigurationProvider, java.io.Closeable, java.lang.AutoCloseable

public final class ConfigCatClient
extends java.lang.Object
implements ConfigurationProvider

A client for handling configurations provided by ConfigCat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigCatClient.Builder A builder that helps construct a ConfigCatClient instance.

Constructor Summary

Constructors

Constructor and Description
ConfigCatClient(java.lang.String sdkKey) Constructs a new client instance with the default configuration.

Method Summary

Modifier and Type	Method and Description
void	close()
void	forceRefresh() Initiates a force refresh synchronously on the cached configuration.
java.util.concurrent.CompletableFuture<java.lang.Void>	forceRefreshAsync() Initiates a force refresh asynchronously on the cached configuration.
java.util.Collection<java.lang.String>	getAllKeys() Gets a collection of all setting keys.
java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>>	getAllKeysAsync() Gets a collection of all setting keys asynchronously.
java.util.Collection<java.lang.String>	getAllVariationIds() Gets the Variation IDs (analytics) of all feature flags or settings synchronously.
java.util.Collection<java.lang.String>	getAllVariationIds(User user) Gets the Variation IDs (analytics) of all feature flags or settings synchronously.
java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>>	getAllVariationIdsAsync() Gets the Variation IDs (analytics) of all feature flags or settings asynchronously.
java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>>	getAllVariationIdsAsync(User user) Gets the Variation IDs (analytics) of all feature flags or settings asynchronously.
<T> java.util.Map.Entry<java.lang.String,T>	getKeyAndValue(java.lang.Class<T> classOfT, java.lang.String variationId) Gets the key of a setting and its value identified by the given Variation ID (analytics).
<T> java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,T>>	getKeyAndValueAsync(java.lang.Class<T> classOfT, java.lang.String variationId) Gets the key of a setting and its value identified by the given Variation ID (analytics).
<T> T	getValue(java.lang.Class<T> classOfT, java.lang.String key, T defaultValue) Gets a value synchronously as T from the configuration identified by the given key.
<T> T	getValue(java.lang.Class<T> classOfT, java.lang.String key, User user, T defaultValue) Gets a value synchronously as T from the configuration identified by the given key.
<T> java.util.concurrent.CompletableFuture<T>	getValueAsync(java.lang.Class<T> classOfT, java.lang.String key, T defaultValue) Gets a value asynchronously as T from the configuration identified by the given key.
<T> java.util.concurrent.CompletableFuture<T>	getValueAsync(java.lang.Class<T> classOfT, java.lang.String key, User user, T defaultValue) Gets a value asynchronously as T from the configuration identified by the given key.
java.lang.String	getVariationId(java.lang.String key, java.lang.String defaultVariationId) Gets the Variation ID (analytics) of a feature flag or setting synchronously based on its key.
java.lang.String	getVariationId(java.lang.String key, User user, java.lang.String defaultVariationId) Gets the Variation ID (analytics) of a feature flag or setting synchronously based on its key.
java.util.concurrent.CompletableFuture<java.lang.String>	getVariationIdAsync(java.lang.String key, java.lang.String defaultVariationId) Gets the Variation ID (analytics) of a feature flag or setting asynchronously based on its key.
java.util.concurrent.CompletableFuture<java.lang.String>	getVariationIdAsync(java.lang.String key, User user, java.lang.String defaultVariationId) Gets the Variation ID (analytics) of a feature flag or setting asynchronously based on its key.
static ConfigCatClient.Builder	newBuilder() Creates a new builder instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigCatClient

public ConfigCatClient(java.lang.String sdkKey)

Constructs a new client instance with the default configuration.

Parameters:

sdkKey - the token which identifies your project configuration.

Method Detail

getValue

public <T> T getValue(java.lang.Class<T> classOfT,
                      java.lang.String key,
                      T defaultValue)

Description copied from interface: ConfigurationProvider

Gets a value synchronously as T from the configuration identified by the given key.

Specified by:

getValue in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

key - the identifier of the configuration value.

defaultValue - in case of any failure, this value will be returned.

Returns:

the configuration value identified by the given key.

getValue

public <T> T getValue(java.lang.Class<T> classOfT,
                      java.lang.String key,
                      User user,
                      T defaultValue)

Description copied from interface: ConfigurationProvider

Gets a value synchronously as T from the configuration identified by the given key.

Specified by:

getValue in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

key - the identifier of the configuration value.

user - the user object to identify the caller.

defaultValue - in case of any failure, this value will be returned.

Returns:

the configuration value identified by the given key.

getValueAsync

public <T> java.util.concurrent.CompletableFuture<T> getValueAsync(java.lang.Class<T> classOfT,
                                                                   java.lang.String key,
                                                                   T defaultValue)

Description copied from interface: ConfigurationProvider

Gets a value asynchronously as T from the configuration identified by the given key.

Specified by:

getValueAsync in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

key - the identifier of the configuration value.

defaultValue - in case of any failure, this value will be returned.

Returns:

a future which computes the configuration value identified by the given key.

getValueAsync

public <T> java.util.concurrent.CompletableFuture<T> getValueAsync(java.lang.Class<T> classOfT,
                                                                   java.lang.String key,
                                                                   User user,
                                                                   T defaultValue)

Description copied from interface: ConfigurationProvider

Gets a value asynchronously as T from the configuration identified by the given key.

Specified by:

getValueAsync in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

key - the identifier of the configuration value.

user - the user object to identify the caller.

defaultValue - in case of any failure, this value will be returned.

Returns:

a future which computes the configuration value identified by the given key.

getVariationId

public java.lang.String getVariationId(java.lang.String key,
                                       java.lang.String defaultVariationId)

Description copied from interface: ConfigurationProvider

Gets the Variation ID (analytics) of a feature flag or setting synchronously based on its key.

Specified by:

getVariationId in interface ConfigurationProvider

Parameters:

key - the identifier of the configuration value.

defaultVariationId - in case of any failure, this value will be returned.

Returns:

the Variation ID.

getVariationId

public java.lang.String getVariationId(java.lang.String key,
                                       User user,
                                       java.lang.String defaultVariationId)

Description copied from interface: ConfigurationProvider

Gets the Variation ID (analytics) of a feature flag or setting synchronously based on its key.

Specified by:

getVariationId in interface ConfigurationProvider

Parameters:

key - the identifier of the configuration value.

user - the user object to identify the caller.

defaultVariationId - in case of any failure, this value will be returned.

Returns:

the Variation ID.

getVariationIdAsync

public java.util.concurrent.CompletableFuture<java.lang.String> getVariationIdAsync(java.lang.String key,
                                                                                    java.lang.String defaultVariationId)

Description copied from interface: ConfigurationProvider

Gets the Variation ID (analytics) of a feature flag or setting asynchronously based on its key.

Specified by:

getVariationIdAsync in interface ConfigurationProvider

Parameters:

key - the identifier of the configuration value.

defaultVariationId - in case of any failure, this value will be returned.

Returns:

a future which computes the Variation ID.

getVariationIdAsync

public java.util.concurrent.CompletableFuture<java.lang.String> getVariationIdAsync(java.lang.String key,
                                                                                    User user,
                                                                                    java.lang.String defaultVariationId)

Description copied from interface: ConfigurationProvider

Gets the Variation ID (analytics) of a feature flag or setting asynchronously based on its key.

Specified by:

getVariationIdAsync in interface ConfigurationProvider

Parameters:

key - the identifier of the configuration value.

user - the user object to identify the caller.

defaultVariationId - in case of any failure, this value will be returned.

Returns:

a future which computes the Variation ID.

getAllVariationIds

public java.util.Collection<java.lang.String> getAllVariationIds()

Description copied from interface: ConfigurationProvider

Gets the Variation IDs (analytics) of all feature flags or settings synchronously.

Specified by:

getAllVariationIds in interface ConfigurationProvider

Returns:

a collection of all Variation IDs.

getAllVariationIdsAsync

public java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>> getAllVariationIdsAsync()

Description copied from interface: ConfigurationProvider

Gets the Variation IDs (analytics) of all feature flags or settings asynchronously.

Specified by:

getAllVariationIdsAsync in interface ConfigurationProvider

Returns:

a future which computes the collection of all Variation IDs.

getAllVariationIds

public java.util.Collection<java.lang.String> getAllVariationIds(User user)

Description copied from interface: ConfigurationProvider

Gets the Variation IDs (analytics) of all feature flags or settings synchronously.

Specified by:

getAllVariationIds in interface ConfigurationProvider

Parameters:

user - the user object to identify the caller.

Returns:

a collection of all Variation IDs.

getAllVariationIdsAsync

public java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>> getAllVariationIdsAsync(User user)

Description copied from interface: ConfigurationProvider

Gets the Variation IDs (analytics) of all feature flags or settings asynchronously.

Specified by:

getAllVariationIdsAsync in interface ConfigurationProvider

Parameters:

user - the user object to identify the caller.

Returns:

a future which computes the collection of all Variation IDs.

getKeyAndValue

public <T> java.util.Map.Entry<java.lang.String,T> getKeyAndValue(java.lang.Class<T> classOfT,
                                                                  java.lang.String variationId)

Description copied from interface: ConfigurationProvider

Gets the key of a setting and its value identified by the given Variation ID (analytics).

Specified by:

getKeyAndValue in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

variationId - the Variation ID.

Returns:

the key of a setting and its value.

getKeyAndValueAsync

public <T> java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,T>> getKeyAndValueAsync(java.lang.Class<T> classOfT,
                                                                                                               java.lang.String variationId)

Description copied from interface: ConfigurationProvider

Gets the key of a setting and its value identified by the given Variation ID (analytics).

Specified by:

getKeyAndValueAsync in interface ConfigurationProvider

Type Parameters:

T - the type of the desired config value.

Parameters:

classOfT - the class of T. Only String, Integer, Double or Boolean types are supported.

variationId - the Variation ID.

Returns:

a future which computes the key of a setting and its value.

getAllKeys

public java.util.Collection<java.lang.String> getAllKeys()

Description copied from interface: ConfigurationProvider

Gets a collection of all setting keys.

Specified by:

getAllKeys in interface ConfigurationProvider

Returns:

a collection of all setting keys.

getAllKeysAsync

public java.util.concurrent.CompletableFuture<java.util.Collection<java.lang.String>> getAllKeysAsync()

Description copied from interface: ConfigurationProvider

Gets a collection of all setting keys asynchronously.

Specified by:

getAllKeysAsync in interface ConfigurationProvider

Returns:

a collection of all setting keys.

forceRefresh

public void forceRefresh()

Description copied from interface: ConfigurationProvider

Initiates a force refresh synchronously on the cached configuration.

Specified by:

forceRefresh in interface ConfigurationProvider

forceRefreshAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> forceRefreshAsync()

Description copied from interface: ConfigurationProvider

Initiates a force refresh asynchronously on the cached configuration.

Specified by:

forceRefreshAsync in interface ConfigurationProvider

Returns:

the future which executes the refresh.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

newBuilder

public static ConfigCatClient.Builder newBuilder()

Creates a new builder instance.

Returns:

the new builder.