com.configcat

Class ConfigCatClient.Builder

java.lang.Object

com.configcat.ConfigCatClient.Builder

Enclosing class:

ConfigCatClient

public static class ConfigCatClient.Builder
extends java.lang.Object

A builder that helps construct a ConfigCatClient instance.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ConfigCatClient.Builder	baseUrl(java.lang.String baseUrl) Sets the base ConfigCat CDN url.
ConfigCatClient	build(java.lang.String sdkKey) Builds the configured ConfigCatClient instance.
ConfigCatClient.Builder	cache(ConfigCache cache) Sets the internal cache implementation.
ConfigCatClient.Builder	dataGovernance(DataGovernance dataGovernance) Default: Global.
ConfigCatClient.Builder	flagOverrides(OverrideDataSourceBuilder dataSourceBuilder, OverrideBehaviour behaviour) Sets feature flag and setting overrides.
ConfigCatClient.Builder	httpClient(okhttp3.OkHttpClient httpClient) Sets the underlying http client which will be used to fetch the latest configuration.
ConfigCatClient.Builder	logLevel(LogLevel logLevel) Default: Warning.
ConfigCatClient.Builder	mode(PollingMode pollingMode) Sets the internal refresh policy implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

httpClient

public ConfigCatClient.Builder httpClient(okhttp3.OkHttpClient httpClient)

Sets the underlying http client which will be used to fetch the latest configuration.

Parameters:

httpClient - the http client.

Returns:

the builder.

cache

public ConfigCatClient.Builder cache(ConfigCache cache)

Sets the internal cache implementation.

Parameters:

cache - a ConfigCache implementation used to cache the configuration.

Returns:

the builder.

baseUrl

public ConfigCatClient.Builder baseUrl(java.lang.String baseUrl)

Sets the base ConfigCat CDN url.

Parameters:

baseUrl - the base ConfigCat CDN url.

Returns:

the builder.

mode

public ConfigCatClient.Builder mode(PollingMode pollingMode)

Sets the internal refresh policy implementation.

Parameters:

pollingMode - the polling mode.

Returns:

the builder.

dataGovernance

public ConfigCatClient.Builder dataGovernance(DataGovernance dataGovernance)

Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard: https://app.configcat.com/organization/data-governance (Only Organization Admins have access)

Parameters:

dataGovernance - the DataGovernance parameter.

Returns:

the builder.

logLevel

public ConfigCatClient.Builder logLevel(LogLevel logLevel)

Default: Warning. Sets the internal log level.

Parameters:

logLevel - the LogLevel parameter.

Returns:

the builder.

flagOverrides

public ConfigCatClient.Builder flagOverrides(OverrideDataSourceBuilder dataSourceBuilder,
                                             OverrideBehaviour behaviour)

Sets feature flag and setting overrides.

Parameters:

dataSourceBuilder - builder that describes the overrides' data source.

behaviour - the override behaviour. It can be used to set preference on whether the local values should override the remote values, or use local values only when a remote value doesn't exist, or use it for local only mode.

Returns:

the builder.

Throws:

java.lang.IllegalArgumentException - when the dataSourceBuilder or behaviour parameter is null.

build

public ConfigCatClient build(java.lang.String sdkKey)

Builds the configured ConfigCatClient instance.

Parameters:

sdkKey - the project token.

Returns:

the configured ConfigCatClient instance.