com.squareup.square.http.client

Class HttpClientConfiguration

java.lang.Object

com.squareup.square.http.client.HttpClientConfiguration

All Implemented Interfaces:

ReadonlyHttpClientConfiguration

public class HttpClientConfiguration
extends Object
implements ReadonlyHttpClientConfiguration

Class to hold HTTP Client Configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClientConfiguration.Builder Class to build instances of HttpClientConfiguration.

Method Summary

Modifier and Type	Method and Description
int	getBackOffFactor() To use in calculation of wait time for next request in case of failure.
okhttp3.OkHttpClient	getHttpClientInstance() The OkHttpClient instance used to make the HTTP calls.
Set<HttpMethod>	getHttpMethodsToRetry() Http methods to retry against.
Set<Integer>	getHttpStatusCodesToRetry() Http status codes to retry against.
long	getMaximumRetryWaitTime() The maximum wait time for overall retrying requests.
int	getNumberOfRetries() The number of retries to make.
long	getRetryInterval() To use in calculation of wait time for next request in case of failure.
long	getTimeout() The timeout in seconds to use for making HTTP requests.
HttpClientConfiguration.Builder	newBuilder() Builds a new HttpClientConfiguration.Builder object.
boolean	shouldOverrideHttpClientConfigurations() Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc.
boolean	shouldRetryOnTimeout() Whether to retry on request timeout.
String	toString() Converts this HttpClientConfiguration into string format.

Methods inherited from class java.lang.Object

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

Method Detail

getTimeout

public long getTimeout()

The timeout in seconds to use for making HTTP requests.

Specified by:

getTimeout in interface ReadonlyHttpClientConfiguration

Returns:

timeout

getNumberOfRetries

public int getNumberOfRetries()

The number of retries to make.

Specified by:

getNumberOfRetries in interface ReadonlyHttpClientConfiguration

Returns:

numberOfRetries

getBackOffFactor

public int getBackOffFactor()

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

Specified by:

getBackOffFactor in interface ReadonlyHttpClientConfiguration

Returns:

backOffFactor

getRetryInterval

public long getRetryInterval()

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

Specified by:

getRetryInterval in interface ReadonlyHttpClientConfiguration

Returns:

retryInterval

getHttpStatusCodesToRetry

public Set<Integer> getHttpStatusCodesToRetry()

Http status codes to retry against.

Specified by:

getHttpStatusCodesToRetry in interface ReadonlyHttpClientConfiguration

Returns:

httpStatusCodesToRetry

getHttpMethodsToRetry

public Set<HttpMethod> getHttpMethodsToRetry()

Http methods to retry against.

Specified by:

getHttpMethodsToRetry in interface ReadonlyHttpClientConfiguration

Returns:

httpMethodsToRetry

getMaximumRetryWaitTime

public long getMaximumRetryWaitTime()

The maximum wait time for overall retrying requests.

Specified by:

getMaximumRetryWaitTime in interface ReadonlyHttpClientConfiguration

Returns:

maximumRetryWaitTime

shouldRetryOnTimeout

public boolean shouldRetryOnTimeout()

Whether to retry on request timeout.

Specified by:

shouldRetryOnTimeout in interface ReadonlyHttpClientConfiguration

Returns:

shouldRetryOnTimeout

getHttpClientInstance

public okhttp3.OkHttpClient getHttpClientInstance()

The OkHttpClient instance used to make the HTTP calls.

Specified by:

getHttpClientInstance in interface ReadonlyHttpClientConfiguration

Returns:

httpClientInstance

shouldOverrideHttpClientConfigurations

public boolean shouldOverrideHttpClientConfigurations()

Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc.

Specified by:

shouldOverrideHttpClientConfigurations in interface ReadonlyHttpClientConfiguration

Returns:

overrideHttpClientConfigurations

toString

public String toString()

Converts this HttpClientConfiguration into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

newBuilder

public HttpClientConfiguration.Builder newBuilder()

Builds a new HttpClientConfiguration.Builder object. Creates the instance with the current state.

Returns:

a new HttpClientConfiguration.Builder object