All Implemented Interfaces:


public final class LithicOkHttpClient.Builder

A builder for LithicOkHttpClient.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final LithicOkHttpClient.Builder`	`dispatcherExecutorService(ExecutorService dispatcherExecutorService)`	The executor service to use for running HTTP requests.
`final LithicOkHttpClient.Builder`	`dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)`	Alias for calling Builder.dispatcherExecutorService with `dispatcherExecutorService.orElse(null)`.
`final LithicOkHttpClient.Builder`	`proxy(Proxy proxy)`
`final LithicOkHttpClient.Builder`	`proxy(Optional<Proxy> proxy)`	Alias for calling Builder.proxy with `proxy.orElse(null)`.
`final LithicOkHttpClient.Builder`	`proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)`	Provides credentials when an HTTP proxy responds with `407 Proxy Authentication Required`.
`final LithicOkHttpClient.Builder`	`proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)`	Alias for calling Builder.proxyAuthenticator with `proxyAuthenticator.orElse(null)`.
`final LithicOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	The maximum number of idle connections kept by the underlying OkHttp connection pool.
`final LithicOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	Alias for Builder.maxIdleConnections.
`final LithicOkHttpClient.Builder`	`maxIdleConnections(Optional<Integer> maxIdleConnections)`	Alias for calling Builder.maxIdleConnections with `maxIdleConnections.orElse(null)`.
`final LithicOkHttpClient.Builder`	`keepAliveDuration(Duration keepAliveDuration)`	The keep-alive duration for idle connections in the underlying OkHttp connection pool.
`final LithicOkHttpClient.Builder`	`keepAliveDuration(Optional<Duration> keepAliveDuration)`	Alias for calling Builder.keepAliveDuration with `keepAliveDuration.orElse(null)`.
`final LithicOkHttpClient.Builder`	`sslSocketFactory(SSLSocketFactory sslSocketFactory)`	The socket factory used to secure HTTPS connections.
`final LithicOkHttpClient.Builder`	`sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)`	Alias for calling Builder.sslSocketFactory with `sslSocketFactory.orElse(null)`.
`final LithicOkHttpClient.Builder`	`trustManager(X509TrustManager trustManager)`	The trust manager used to secure HTTPS connections.
`final LithicOkHttpClient.Builder`	`trustManager(Optional<X509TrustManager> trustManager)`	Alias for calling Builder.trustManager with `trustManager.orElse(null)`.
`final LithicOkHttpClient.Builder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)`	The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`final LithicOkHttpClient.Builder`	`hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)`	Alias for calling Builder.hostnameVerifier with `hostnameVerifier.orElse(null)`.
`final LithicOkHttpClient.Builder`	`checkJacksonVersionCompatibility(Boolean checkJacksonVersionCompatibility)`	Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
`final LithicOkHttpClient.Builder`	`jsonMapper(JsonMapper jsonMapper)`	The Jackson JSON mapper to use for serializing and deserializing JSON.
`final LithicOkHttpClient.Builder`	`streamHandlerExecutor(Executor streamHandlerExecutor)`	The executor to use for running AsyncStreamResponse.Handler callbacks.
`final LithicOkHttpClient.Builder`	`sleeper(Sleeper sleeper)`	The interface to use for delaying execution, like during retries.
`final LithicOkHttpClient.Builder`	`clock(Clock clock)`	The clock to use for operations that require timing, like retries.
`final LithicOkHttpClient.Builder`	`baseUrl(String baseUrl)`	The base URL to use for every request.
`final LithicOkHttpClient.Builder`	`baseUrl(Optional<String> baseUrl)`	Alias for calling Builder.baseUrl with `baseUrl.orElse(null)`.
`final LithicOkHttpClient.Builder`	`sandbox()`	Sets baseUrl to `https://sandbox.lithic.com`.
`final LithicOkHttpClient.Builder`	`responseValidation(Boolean responseValidation)`	Whether to call `validate` on every response before returning it.
`final LithicOkHttpClient.Builder`	`timeout(Timeout timeout)`	Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
`final LithicOkHttpClient.Builder`	`timeout(Duration timeout)`	Sets the maximum time allowed for a complete HTTP call, not including retries.
`final LithicOkHttpClient.Builder`	`maxRetries(Integer maxRetries)`	The maximum number of times to retry failed requests, with a short exponential backoff between requests.
`final LithicOkHttpClient.Builder`	`logLevel(LogLevel logLevel)`	The level at which to log request and response information.
`final LithicOkHttpClient.Builder`	`apiKey(String apiKey)`
`final LithicOkHttpClient.Builder`	`webhookSecret(String webhookSecret)`
`final LithicOkHttpClient.Builder`	`webhookSecret(Optional<String> webhookSecret)`	Alias for calling Builder.webhookSecret with `webhookSecret.orElse(null)`.
`final LithicOkHttpClient.Builder`	`headers(Headers headers)`
`final LithicOkHttpClient.Builder`	`headers(Map<String, Iterable<String>> headers)`
`final LithicOkHttpClient.Builder`	`putHeader(String name, String value)`
`final LithicOkHttpClient.Builder`	`putHeaders(String name, Iterable<String> values)`
`final LithicOkHttpClient.Builder`	`putAllHeaders(Headers headers)`
`final LithicOkHttpClient.Builder`	`putAllHeaders(Map<String, Iterable<String>> headers)`
`final LithicOkHttpClient.Builder`	`replaceHeaders(String name, String value)`
`final LithicOkHttpClient.Builder`	`replaceHeaders(String name, Iterable<String> values)`
`final LithicOkHttpClient.Builder`	`replaceAllHeaders(Headers headers)`
`final LithicOkHttpClient.Builder`	`replaceAllHeaders(Map<String, Iterable<String>> headers)`
`final LithicOkHttpClient.Builder`	`removeHeaders(String name)`
`final LithicOkHttpClient.Builder`	`removeAllHeaders(Set<String> names)`
`final LithicOkHttpClient.Builder`	`queryParams(QueryParams queryParams)`
`final LithicOkHttpClient.Builder`	`queryParams(Map<String, Iterable<String>> queryParams)`
`final LithicOkHttpClient.Builder`	`putQueryParam(String key, String value)`
`final LithicOkHttpClient.Builder`	`putQueryParams(String key, Iterable<String> values)`
`final LithicOkHttpClient.Builder`	`putAllQueryParams(QueryParams queryParams)`
`final LithicOkHttpClient.Builder`	`putAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final LithicOkHttpClient.Builder`	`replaceQueryParams(String key, String value)`
`final LithicOkHttpClient.Builder`	`replaceQueryParams(String key, Iterable<String> values)`
`final LithicOkHttpClient.Builder`	`replaceAllQueryParams(QueryParams queryParams)`
`final LithicOkHttpClient.Builder`	`replaceAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final LithicOkHttpClient.Builder`	`removeQueryParams(String key)`
`final LithicOkHttpClient.Builder`	`removeAllQueryParams(Set<String> keys)`
`final LithicOkHttpClient.Builder`	`fromEnv()`	Updates configuration using system properties and environment variables.
`final LithicClient`	`build()`	Returns an immutable instance of LithicClient.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final LithicOkHttpClient.Builder dispatcherExecutorService(ExecutorService dispatcherExecutorService)
```
    The executor service to use for running HTTP requests.
    Defaults to OkHttp's default executor service.
    This class takes ownership of the executor service and shuts it down when closed.
  - dispatcherExecutorService
```
 final LithicOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final LithicOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final LithicOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - proxyAuthenticator
```
 final LithicOkHttpClient.Builder proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)
```
    Provides credentials when an HTTP proxy responds with 407 Proxy Authentication Required.
  - proxyAuthenticator
```
 final LithicOkHttpClient.Builder proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)
```
    Alias for calling Builder.proxyAuthenticator with proxyAuthenticator.orElse(null).
  - maxIdleConnections
```
 final LithicOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    The maximum number of idle connections kept by the underlying OkHttp connection pool.
    If this is set, then keepAliveDuration must also be set.
    If unset, then OkHttp's default is used.
  - maxIdleConnections
```
 final LithicOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final LithicOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final LithicOkHttpClient.Builder keepAliveDuration(Duration keepAliveDuration)
```
    The keep-alive duration for idle connections in the underlying OkHttp connection pool.
    If this is set, then maxIdleConnections must also be set.
    If unset, then OkHttp's default is used.
  - keepAliveDuration
```
 final LithicOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final LithicOkHttpClient.Builder sslSocketFactory(SSLSocketFactory sslSocketFactory)
```
    The socket factory used to secure HTTPS connections.
    If this is set, then trustManager must also be set.
    If unset, then the system default is used. Most applications should not call this method, and instead use the system default. The default include special optimizations that can be lost if the implementation is modified.
  - sslSocketFactory
```
 final LithicOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final LithicOkHttpClient.Builder trustManager(X509TrustManager trustManager)
```
    The trust manager used to secure HTTPS connections.
    If this is set, then sslSocketFactory must also be set.
    If unset, then the system default is used. Most applications should not call this method, and instead use the system default. The default include special optimizations that can be lost if the implementation is modified.
  - trustManager
```
 final LithicOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final LithicOkHttpClient.Builder hostnameVerifier(HostnameVerifier hostnameVerifier)
```
    The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
    If unset, then a default hostname verifier is used.
  - hostnameVerifier
```
 final LithicOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final LithicOkHttpClient.Builder checkJacksonVersionCompatibility(Boolean checkJacksonVersionCompatibility)
```
    Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
    Defaults to true. Use extreme caution when disabling this option. There is no guarantee that the SDK will work correctly when using an incompatible Jackson version.
  - jsonMapper
```
 final LithicOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.lithic.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - streamHandlerExecutor
```
 final LithicOkHttpClient.Builder streamHandlerExecutor(Executor streamHandlerExecutor)
```
    The executor to use for running AsyncStreamResponse.Handler callbacks.
    Defaults to a dedicated cached thread pool.
    This class takes ownership of the executor and shuts it down, if possible, when closed.
  - sleeper
```
 final LithicOkHttpClient.Builder sleeper(Sleeper sleeper)
```
    The interface to use for delaying execution, like during retries.
    This is primarily useful for using fake delays in tests.
    Defaults to real execution delays.
    This class takes ownership of the sleeper and closes it when closed.
  - clock
```
 final LithicOkHttpClient.Builder clock(Clock clock)
```
    The clock to use for operations that require timing, like retries.
    This is primarily useful for using a fake clock in tests.
    Defaults to Clock.systemUTC.
  - baseUrl
```
 final LithicOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.lithic.com.
    The following other environments, with dedicated builder methods, are available:
    sandbox: https://sandbox.lithic.com
  - baseUrl
```
 final LithicOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - sandbox
```
 final LithicOkHttpClient.Builder sandbox()
```
    Sets baseUrl to https://sandbox.lithic.com.
  - responseValidation
```
 final LithicOkHttpClient.Builder responseValidation(Boolean responseValidation)
```
    Whether to call validate on every response before returning it.
    Setting this to true is not forwards compatible with new types from the API for existing fields.
    Defaults to false, which means the shape of the response will not be validated upfront. Instead, validation will only occur for the parts of the response that are accessed.
  - timeout
```
 final LithicOkHttpClient.Builder timeout(Timeout timeout)
```
    Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
    Defaults to Timeout.default.
  - timeout
```
 final LithicOkHttpClient.Builder timeout(Duration timeout)
```
    Sets the maximum time allowed for a complete HTTP call, not including retries.
    See Timeout.request for more details.
    For fine-grained control, pass a Timeout object.
  - maxRetries
```
 final LithicOkHttpClient.Builder maxRetries(Integer maxRetries)
```
    The maximum number of times to retry failed requests, with a short exponential backoff between requests.
    Only the following error types are retried:
    Connection errors (for example, due to a network connectivity problem)
    408 Request Timeout
    409 Conflict
    429 Rate Limit
    5xx Internal
    The API may also explicitly instruct the SDK to retry or not retry a request.
    Defaults to 2.
  - logLevel
```
 final LithicOkHttpClient.Builder logLevel(LogLevel logLevel)
```
    The level at which to log request and response information.
    fromEnv will set the level from environment variables. See LogLevel.fromEnv.
    Defaults to LogLevel.fromEnv.
  - apiKey
```
 final LithicOkHttpClient.Builder apiKey(String apiKey)
```
  - webhookSecret
```
 final LithicOkHttpClient.Builder webhookSecret(String webhookSecret)
```
  - webhookSecret
```
 final LithicOkHttpClient.Builder webhookSecret(Optional<String> webhookSecret)
```
    Alias for calling Builder.webhookSecret with webhookSecret.orElse(null).
  - headers
```
 final LithicOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final LithicOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final LithicOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final LithicOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final LithicOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final LithicOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final LithicOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final LithicOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final LithicOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final LithicOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final LithicOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final LithicOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final LithicOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final LithicOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final LithicOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final LithicOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final LithicOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final LithicOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final LithicOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final LithicOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final LithicOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final LithicOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final LithicOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final LithicOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final LithicOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final LithicClient build()
```
    Returns an immutable instance of LithicClient.
    Further updates to this Builder will not mutate the returned instance.

Class LithicOkHttpClient.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

dispatcherExecutorService

dispatcherExecutorService

proxy

proxy

proxyAuthenticator

proxyAuthenticator

maxIdleConnections

maxIdleConnections

maxIdleConnections

keepAliveDuration

keepAliveDuration

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

streamHandlerExecutor

sleeper

clock

baseUrl

baseUrl

sandbox

responseValidation

timeout

timeout

maxRetries

logLevel

apiKey

webhookSecret

webhookSecret

headers

headers

putHeader

putHeaders

putAllHeaders

putAllHeaders

replaceHeaders

replaceHeaders

replaceAllHeaders

replaceAllHeaders

removeHeaders

removeAllHeaders

queryParams

queryParams

putQueryParam

putQueryParams

putAllQueryParams

putAllQueryParams

replaceQueryParams

replaceQueryParams

replaceAllQueryParams

replaceAllQueryParams

removeQueryParams

removeAllQueryParams

fromEnv

build