com.squareup.square.http.client

Class HttpClientConfiguration.Builder

java.lang.Object

com.squareup.square.http.client.HttpClientConfiguration.Builder

Enclosing class:

HttpClientConfiguration

public static class HttpClientConfiguration.Builder
extends Object

Class to build instances of HttpClientConfiguration.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpClientConfiguration.Builder	backOffFactor(int backOffFactor) To use in calculation of wait time for next request in case of failure.
HttpClientConfiguration	build() Builds a new HttpClientConfiguration object using the set fields.
HttpClientConfiguration.Builder	httpClientInstance(okhttp3.OkHttpClient httpClientInstance) The OkHttpClient instance used to make the HTTP calls.
HttpClientConfiguration.Builder	httpClientInstance(okhttp3.OkHttpClient httpClientInstance, boolean overrideHttpClientConfigurations) The OkHttpClient instance used to make the HTTP calls.
HttpClientConfiguration.Builder	httpMethodsToRetry(Set<HttpMethod> httpMethodsToRetry) Http methods to retry against.
HttpClientConfiguration.Builder	httpStatusCodesToRetry(Set<Integer> httpStatusCodesToRetry) Http status codes to retry against.
HttpClientConfiguration.Builder	maximumRetryWaitTime(long maximumRetryWaitTime) The maximum wait time for overall retrying requests.
HttpClientConfiguration.Builder	numberOfRetries(int numberOfRetries) The number of retries to make.
HttpClientConfiguration.Builder	retryInterval(long retryInterval) To use in calculation of wait time for next request in case of failure.
HttpClientConfiguration.Builder	shouldRetryOnTimeout(boolean shouldRetryOnTimeout) Whether to retry on request timeout.
HttpClientConfiguration.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 HttpClientConfiguration.Builder timeout(long timeout)

The timeout in seconds to use for making HTTP requests.

Parameters:

timeout - The timeout to set.

Returns:

Builder

numberOfRetries

public HttpClientConfiguration.Builder numberOfRetries(int numberOfRetries)

The number of retries to make.

Parameters:

numberOfRetries - The numberOfRetries to set.

Returns:

Builder

backOffFactor

public HttpClientConfiguration.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 HttpClientConfiguration.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 HttpClientConfiguration.Builder httpStatusCodesToRetry(Set<Integer> httpStatusCodesToRetry)

Http status codes to retry against.

Parameters:

httpStatusCodesToRetry - The httpStatusCodesToRetry to set.

Returns:

Builder

httpMethodsToRetry

public HttpClientConfiguration.Builder httpMethodsToRetry(Set<HttpMethod> httpMethodsToRetry)

Http methods to retry against.

Parameters:

httpMethodsToRetry - The httpMethodsToRetry to set.

Returns:

Builder

maximumRetryWaitTime

public HttpClientConfiguration.Builder maximumRetryWaitTime(long maximumRetryWaitTime)

The maximum wait time for overall retrying requests.

Parameters:

maximumRetryWaitTime - The maximumRetryWaitTime to set.

Returns:

Builder

shouldRetryOnTimeout

public HttpClientConfiguration.Builder shouldRetryOnTimeout(boolean shouldRetryOnTimeout)

Whether to retry on request timeout.

Parameters:

shouldRetryOnTimeout - The shouldRetryOnTimeout to set

Returns:

Builder

httpClientInstance

public HttpClientConfiguration.Builder httpClientInstance(okhttp3.OkHttpClient httpClientInstance)

The OkHttpClient instance used to make the HTTP calls.

Parameters:

httpClientInstance - The httpClientInstance to set

Returns:

Builder

httpClientInstance

public HttpClientConfiguration.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

build

public HttpClientConfiguration build()

Builds a new HttpClientConfiguration object using the set fields.

Returns:

HttpClientConfiguration