io.apimatic.core.configurations.http.client

Class CoreHttpClientConfiguration.Builder

java.lang.Object

io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Enclosing class:

CoreHttpClientConfiguration

public static class CoreHttpClientConfiguration.Builder
extends Object

Class to build instances of CoreHttpClientConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder() Default Constructor to initiate builder with default properties.

Method Summary

Modifier and Type	Method and Description
CoreHttpClientConfiguration.Builder	backOffFactor(int backOffFactor) To use in calculation of wait time for next request in case of failure.
CoreHttpClientConfiguration	build() Builds a new HttpClientConfiguration object using the set fields.
CoreHttpClientConfiguration.Builder	httpClientInstance(okhttp3.OkHttpClient httpClientInstance) The OkHttpClient instance used to make the HTTP calls.
CoreHttpClientConfiguration.Builder	httpClientInstance(okhttp3.OkHttpClient httpClientInstance, boolean overrideHttpClientConfigurations) The OkHttpClient instance used to make the HTTP calls.
CoreHttpClientConfiguration.Builder	httpMethodsToRetry(Set<io.apimatic.coreinterfaces.http.Method> httpMethodsToRetry) Http methods to retry against.
CoreHttpClientConfiguration.Builder	httpStatusCodesToRetry(Set<Integer> httpStatusCodesToRetry) Http status codes to retry against.
CoreHttpClientConfiguration.Builder	maximumRetryWaitTime(long maximumRetryWaitTime) The maximum wait time for overall retrying requests.
CoreHttpClientConfiguration.Builder	numberOfRetries(int numberOfRetries) The number of retries to make.
CoreHttpClientConfiguration.Builder	proxyConfiguration(io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration proxyConfiguration) Sets the proxy configuration to be used for routing requests through a proxy server.
CoreHttpClientConfiguration.Builder	retryInterval(long retryInterval) To use in calculation of wait time for next request in case of failure.
CoreHttpClientConfiguration.Builder	shouldRetryOnTimeout(boolean shouldRetryOnTimeout) Whether to retry on request timeout.
CoreHttpClientConfiguration.Builder	skipSslCertVerification(boolean skipSslCertVerification) Whether to prevent SSL cert verification or not.
CoreHttpClientConfiguration.Builder	timeout(long timeout) The timeout in seconds to use for making HTTP requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default Constructor to initiate builder with default properties.

Method Detail

timeout

public CoreHttpClientConfiguration.Builder timeout(long timeout)

The timeout in seconds to use for making HTTP requests.

Parameters:

timeout - The timeout to set.

Returns:

Builder.

numberOfRetries

public CoreHttpClientConfiguration.Builder numberOfRetries(int numberOfRetries)

The number of retries to make.

Parameters:

numberOfRetries - The numberOfRetries to set.

Returns:

Builder.

backOffFactor

public CoreHttpClientConfiguration.Builder backOffFactor(int backOffFactor)

To use in calculation of wait time for next request in case of failure.

Parameters:

backOffFactor - The backOffFactor to set.

Returns:

Builder.

retryInterval

public CoreHttpClientConfiguration.Builder retryInterval(long retryInterval)

To use in calculation of wait time for next request in case of failure.

Parameters:

retryInterval - The retryInterval to set.

Returns:

Builder.

httpStatusCodesToRetry

public CoreHttpClientConfiguration.Builder httpStatusCodesToRetry(Set<Integer> httpStatusCodesToRetry)

Http status codes to retry against.

Parameters:

httpStatusCodesToRetry - The httpStatusCodesToRetry to set.

Returns:

Builder.

httpMethodsToRetry

public CoreHttpClientConfiguration.Builder httpMethodsToRetry(Set<io.apimatic.coreinterfaces.http.Method> httpMethodsToRetry)

Http methods to retry against.

Parameters:

httpMethodsToRetry - The httpMethodsToRetry to set.

Returns:

Builder.

maximumRetryWaitTime

public CoreHttpClientConfiguration.Builder maximumRetryWaitTime(long maximumRetryWaitTime)

The maximum wait time for overall retrying requests.

Parameters:

maximumRetryWaitTime - The maximumRetryWaitTime to set.

Returns:

Builder.

shouldRetryOnTimeout

public CoreHttpClientConfiguration.Builder shouldRetryOnTimeout(boolean shouldRetryOnTimeout)

Whether to retry on request timeout.

Parameters:

shouldRetryOnTimeout - The shouldRetryOnTimeout to set

Returns:

Builder.

httpClientInstance

public CoreHttpClientConfiguration.Builder httpClientInstance(okhttp3.OkHttpClient httpClientInstance)

The OkHttpClient instance used to make the HTTP calls.

Parameters:

httpClientInstance - The httpClientInstance to set

Returns:

Builder.

httpClientInstance

public CoreHttpClientConfiguration.Builder httpClientInstance(okhttp3.OkHttpClient httpClientInstance,
                                                              boolean overrideHttpClientConfigurations)

The OkHttpClient instance used to make the HTTP calls.

Parameters:

httpClientInstance - The httpClientInstance to set.

overrideHttpClientConfigurations - The overrideHttpClientConfigurations to set.

Returns:

Builder.

skipSslCertVerification

public CoreHttpClientConfiguration.Builder skipSslCertVerification(boolean skipSslCertVerification)

Whether to prevent SSL cert verification or not.

Parameters:

skipSslCertVerification - The skipSslCertVerification to set.

Returns:

Builder.

proxyConfiguration

public CoreHttpClientConfiguration.Builder proxyConfiguration(io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration proxyConfiguration)

Sets the proxy configuration to be used for routing requests through a proxy server.

Parameters:

proxyConfiguration - the ProxyConfiguration instance to use

Returns:

the builder instance

build

public CoreHttpClientConfiguration build()

Builds a new HttpClientConfiguration object using the set fields.

Returns:

CoreHttpClientConfiguration.