io.apimatic.core.configurations.http.client

Class CoreHttpClientConfiguration

java.lang.Object

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

All Implemented Interfaces:

io.apimatic.coreinterfaces.http.ClientConfiguration

public final class CoreHttpClientConfiguration
extends Object
implements io.apimatic.coreinterfaces.http.ClientConfiguration

Class to hold HTTP Client Configuration.

Nested Class Summary

Nested Classes

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

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<io.apimatic.coreinterfaces.http.Method>	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.
io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration	getProxyConfiguration() Returns the proxy configuration used to route requests through a proxy server.
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.
CoreHttpClientConfiguration.Builder	newBuilder() Builds a new CoreHttpClientConfiguration.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.
boolean	skipSslCertVerification() Allow or prevent skipping SSL certificate verification.
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 io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

timeout.

getNumberOfRetries

public int getNumberOfRetries()

The number of retries to make.

Specified by:

getNumberOfRetries in interface io.apimatic.coreinterfaces.http.ClientConfiguration

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 io.apimatic.coreinterfaces.http.ClientConfiguration

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 io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

retryInterval.

getHttpStatusCodesToRetry

public Set<Integer> getHttpStatusCodesToRetry()

Http status codes to retry against.

Specified by:

getHttpStatusCodesToRetry in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

httpStatusCodesToRetry.

getHttpMethodsToRetry

public Set<io.apimatic.coreinterfaces.http.Method> getHttpMethodsToRetry()

Http methods to retry against.

Specified by:

getHttpMethodsToRetry in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

httpMethodsToRetry.

getMaximumRetryWaitTime

public long getMaximumRetryWaitTime()

The maximum wait time for overall retrying requests.

Specified by:

getMaximumRetryWaitTime in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

maximumRetryWaitTime.

shouldRetryOnTimeout

public boolean shouldRetryOnTimeout()

Whether to retry on request timeout.

Specified by:

shouldRetryOnTimeout in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

shouldRetryOnTimeout.

getHttpClientInstance

public okhttp3.OkHttpClient getHttpClientInstance()

The OkHttpClient instance used to make the HTTP calls.

Specified by:

getHttpClientInstance in interface io.apimatic.coreinterfaces.http.ClientConfiguration

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 io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

overrideHttpClientConfigurations.

skipSslCertVerification

public boolean skipSslCertVerification()

Allow or prevent skipping SSL certificate verification.

Specified by:

skipSslCertVerification in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

skipSslCertVerification.

getProxyConfiguration

public io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration getProxyConfiguration()

Returns the proxy configuration used to route requests through a proxy server. This includes the proxy address, port, and any authentication credentials.

Specified by:

getProxyConfiguration in interface io.apimatic.coreinterfaces.http.ClientConfiguration

Returns:

the ProxyConfiguration

toString

public String toString()

Converts this HttpClientConfiguration into string format.

Overrides:

toString in class Object

Returns:

String representation of this class.

newBuilder

public CoreHttpClientConfiguration.Builder newBuilder()

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

Returns:

a new CoreHttpClientConfiguration.Builder object.