Package io.getunleash.util

Class UnleashConfig.Builder

java.lang.Object

io.getunleash.util.UnleashConfig.Builder

Enclosing class:

UnleashConfig

public static class UnleashConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UnleashConfig.Builder	apiKey(String apiKey)	Adds a custom http header for authorizing the client
UnleashConfig.Builder	appName(String appName)
UnleashConfig.Builder	backupFile(String backupFile)
UnleashConfig	build()
UnleashConfig.Builder	customHttpHeader(String name, String value)
UnleashConfig.Builder	customHttpHeadersProvider(CustomHttpHeadersProvider provider)
UnleashConfig.Builder	disableMetrics()	Don't send metrics to Unleash server
UnleashConfig.Builder	disablePolling()	Don't poll for feature toggle updates
UnleashConfig.Builder	enableProxyAuthenticationByJvmProperties()
UnleashConfig.Builder	environment(String environment)	Deprecated, for removal: This API element is subject to removal in a future version. Environment is a first class citizen in Unleash 4.0.0 and later.
UnleashConfig.Builder	experimentalStreamingMode()
UnleashConfig.Builder	fallbackStrategy(Strategy fallbackStrategy)
UnleashConfig.Builder	fetchTogglesConnectTimeout(Duration connectTimeout)
UnleashConfig.Builder	fetchTogglesConnectTimeoutSeconds(long connectTimeoutSeconds)
UnleashConfig.Builder	fetchTogglesInterval(long fetchTogglesInterval)
UnleashConfig.Builder	fetchTogglesReadTimeout(Duration readTimeout)
UnleashConfig.Builder	fetchTogglesReadTimeoutSeconds(long readTimeoutSeconds)
String	getDefaultSdkVersion()
UnleashConfig.Builder	impactMetricsRegistry(ImpactMetricRegistryAndDataSource impactMetricsRegistry)
UnleashConfig.Builder	instanceId(String instanceId)
UnleashConfig.Builder	metricsSenderFactory(MetricSenderFactory metricSenderFactory)
UnleashConfig.Builder	namePrefix(String namePrefix)
UnleashConfig.Builder	projectName(String projectName)
UnleashConfig.Builder	proxy(Proxy proxy)
UnleashConfig.Builder	proxy(Proxy proxy, String proxyUser, String proxyPassword)
UnleashConfig.Builder	scheduledExecutor(UnleashScheduledExecutor scheduledExecutor)
UnleashConfig.Builder	sendMetricsConnectTimeout(Duration connectTimeout)
UnleashConfig.Builder	sendMetricsConnectTimeoutSeconds(long connectTimeoutSeconds)
UnleashConfig.Builder	sendMetricsInterval(long sendMetricsInterval)
UnleashConfig.Builder	sendMetricsReadTimeout(Duration readTimeout)
UnleashConfig.Builder	sendMetricsReadTimeoutSeconds(long readTimeoutSeconds)
UnleashConfig.Builder	startupExceptionHandler(Consumer<UnleashException> startupExceptionHandler)	Used to handle exceptions when starting up synchronously.
UnleashConfig.Builder	subscriber(UnleashSubscriber unleashSubscriber)
UnleashConfig.Builder	synchronousFetchOnInitialisation(boolean enable)
UnleashConfig.Builder	toggleBootstrapProvider(ToggleBootstrapProvider toggleBootstrapProvider)
UnleashConfig.Builder	unleashAPI(String unleashAPI)
UnleashConfig.Builder	unleashAPI(URI unleashAPI)
UnleashConfig.Builder	unleashContextProvider(UnleashContextProvider contextProvider)
UnleashConfig.Builder	unleashFeatureFetcherFactory(UnleashFeatureFetcherFactory unleashFeatureFetcherFactory)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

unleashAPI

public UnleashConfig.Builder unleashAPI(URI unleashAPI)

unleashAPI

public UnleashConfig.Builder unleashAPI(String unleashAPI)

customHttpHeader

public UnleashConfig.Builder customHttpHeader(String name,
 String value)

customHttpHeadersProvider

public UnleashConfig.Builder customHttpHeadersProvider(CustomHttpHeadersProvider provider)

appName

public UnleashConfig.Builder appName(String appName)

environment

@Deprecated(since="12.0.0",
            forRemoval=true)
public UnleashConfig.Builder environment(String environment)

Deprecated, for removal: This API element is subject to removal in a future version.

Environment is a first class citizen in Unleash 4.0.0 and later. From v13.0.0 of the Java SDK, this will be computed from the API key provided instead of being manually set.

instanceId

public UnleashConfig.Builder instanceId(String instanceId)

projectName

public UnleashConfig.Builder projectName(String projectName)

namePrefix

public UnleashConfig.Builder namePrefix(String namePrefix)

unleashFeatureFetcherFactory

public UnleashConfig.Builder unleashFeatureFetcherFactory(UnleashFeatureFetcherFactory unleashFeatureFetcherFactory)

metricsSenderFactory

public UnleashConfig.Builder metricsSenderFactory(MetricSenderFactory metricSenderFactory)

fetchTogglesInterval

public UnleashConfig.Builder fetchTogglesInterval(long fetchTogglesInterval)

fetchTogglesConnectTimeout

public UnleashConfig.Builder fetchTogglesConnectTimeout(Duration connectTimeout)

fetchTogglesConnectTimeoutSeconds

public UnleashConfig.Builder fetchTogglesConnectTimeoutSeconds(long connectTimeoutSeconds)

fetchTogglesReadTimeout

public UnleashConfig.Builder fetchTogglesReadTimeout(Duration readTimeout)

fetchTogglesReadTimeoutSeconds

public UnleashConfig.Builder fetchTogglesReadTimeoutSeconds(long readTimeoutSeconds)

sendMetricsInterval

public UnleashConfig.Builder sendMetricsInterval(long sendMetricsInterval)

disablePolling

public UnleashConfig.Builder disablePolling()

Don't poll for feature toggle updates

experimentalStreamingMode

public UnleashConfig.Builder experimentalStreamingMode()

sendMetricsConnectTimeout

public UnleashConfig.Builder sendMetricsConnectTimeout(Duration connectTimeout)

sendMetricsConnectTimeoutSeconds

public UnleashConfig.Builder sendMetricsConnectTimeoutSeconds(long connectTimeoutSeconds)

sendMetricsReadTimeout

public UnleashConfig.Builder sendMetricsReadTimeout(Duration readTimeout)

sendMetricsReadTimeoutSeconds

public UnleashConfig.Builder sendMetricsReadTimeoutSeconds(long readTimeoutSeconds)

disableMetrics

public UnleashConfig.Builder disableMetrics()

Don't send metrics to Unleash server

Returns:

backupFile

public UnleashConfig.Builder backupFile(String backupFile)

enableProxyAuthenticationByJvmProperties

public UnleashConfig.Builder enableProxyAuthenticationByJvmProperties()

unleashContextProvider

public UnleashConfig.Builder unleashContextProvider(UnleashContextProvider contextProvider)

synchronousFetchOnInitialisation

public UnleashConfig.Builder synchronousFetchOnInitialisation(boolean enable)

scheduledExecutor

public UnleashConfig.Builder scheduledExecutor(UnleashScheduledExecutor scheduledExecutor)

subscriber

public UnleashConfig.Builder subscriber(UnleashSubscriber unleashSubscriber)

fallbackStrategy

public UnleashConfig.Builder fallbackStrategy(@Nullable
 Strategy fallbackStrategy)

toggleBootstrapProvider

public UnleashConfig.Builder toggleBootstrapProvider(@Nullable
 ToggleBootstrapProvider toggleBootstrapProvider)

proxy

public UnleashConfig.Builder proxy(Proxy proxy)

proxy

public UnleashConfig.Builder proxy(Proxy proxy,
 @Nullable
 String proxyUser,
 @Nullable
 String proxyPassword)

apiKey

public UnleashConfig.Builder apiKey(String apiKey)

Adds a custom http header for authorizing the client

Parameters:

apiKey - the client key to use to connect to the Unleash Server

Returns:

startupExceptionHandler

public UnleashConfig.Builder startupExceptionHandler(@Nullable
 Consumer<UnleashException> startupExceptionHandler)

Used to handle exceptions when starting up synchronously. Allows user the option to choose how errors should be handled.

Parameters:

startupExceptionHandler - - a lambda taking the Exception and doing what it wants to the system.

impactMetricsRegistry

public UnleashConfig.Builder impactMetricsRegistry(@Nullable
 ImpactMetricRegistryAndDataSource impactMetricsRegistry)

build

public UnleashConfig build()

getDefaultSdkVersion

public String getDefaultSdkVersion()