com.azure.core.http.okhttp

Class OkHttpAsyncHttpClientBuilder

java.lang.Object

com.azure.core.http.okhttp.OkHttpAsyncHttpClientBuilder

public class OkHttpAsyncHttpClientBuilder
extends Object

Builder class responsible for creating instances of HttpClient backed by OkHttp.

Constructor Summary

Constructors

Constructor and Description
OkHttpAsyncHttpClientBuilder() Creates OkHttpAsyncHttpClientBuilder.
OkHttpAsyncHttpClientBuilder(okhttp3.OkHttpClient okHttpClient) Creates OkHttpAsyncHttpClientBuilder from the builder of an existing OkHttpClient.

Method Summary

Modifier and Type	Method and Description
OkHttpAsyncHttpClientBuilder	addNetworkInterceptor(okhttp3.Interceptor networkInterceptor) Add a network layer interceptor to Http request pipeline.
HttpClient	build() Creates a new OkHttp-backed HttpClient instance on every call, using the configuration set in the builder at the time of the build method call.
OkHttpAsyncHttpClientBuilder	configuration(Configuration configuration) Sets the configuration store that is used during construction of the HTTP client.
OkHttpAsyncHttpClientBuilder	connectionPool(okhttp3.ConnectionPool connectionPool) Sets the Http connection pool.
OkHttpAsyncHttpClientBuilder	connectionTimeout(Duration connectionTimeout) Sets the connection timeout.
OkHttpAsyncHttpClientBuilder	dispatcher(okhttp3.Dispatcher dispatcher) Sets the dispatcher that also composes the thread pool for executing HTTP requests.
OkHttpAsyncHttpClientBuilder	networkInterceptors(List<okhttp3.Interceptor> networkInterceptors) Add network layer interceptors to Http request pipeline.
OkHttpAsyncHttpClientBuilder	proxy(ProxyOptions proxyOptions) Sets the proxy.
OkHttpAsyncHttpClientBuilder	readTimeout(Duration readTimeout) Sets the read timeout.
OkHttpAsyncHttpClientBuilder	writeTimeout(Duration writeTimeout) Sets the write timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpAsyncHttpClientBuilder

public OkHttpAsyncHttpClientBuilder()

Creates OkHttpAsyncHttpClientBuilder.

OkHttpAsyncHttpClientBuilder

public OkHttpAsyncHttpClientBuilder(okhttp3.OkHttpClient okHttpClient)

Creates OkHttpAsyncHttpClientBuilder from the builder of an existing OkHttpClient.

Parameters:

okHttpClient - the httpclient

Method Detail

addNetworkInterceptor

public OkHttpAsyncHttpClientBuilder addNetworkInterceptor(okhttp3.Interceptor networkInterceptor)

Add a network layer interceptor to Http request pipeline.

Parameters:

networkInterceptor - the interceptor to add

Returns:

the updated OkHttpAsyncHttpClientBuilder object

networkInterceptors

public OkHttpAsyncHttpClientBuilder networkInterceptors(List<okhttp3.Interceptor> networkInterceptors)

Add network layer interceptors to Http request pipeline.

This replaces all previously-set interceptors.

Parameters:

networkInterceptors - The interceptors to add.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

readTimeout

public OkHttpAsyncHttpClientBuilder readTimeout(Duration readTimeout)

Sets the read timeout.

If readTimeout is null a default timeout of 60 seconds will be used. If the timeout is less than or equal to zero then no timeout will be used. Otherwise, the maximum of one millisecond and the passed timeout will be used.

Parameters:

readTimeout - The read timeout.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

writeTimeout

public OkHttpAsyncHttpClientBuilder writeTimeout(Duration writeTimeout)

Sets the write timeout.

If writeTimeout is null a default timeout of 60 seconds will be used. If the timeout is less than or equal to zero then no timeout will be used. Otherwise, the maximum of one millisecond and the passed timeout will be used.

Parameters:

writeTimeout - The write timeout.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

connectionTimeout

public OkHttpAsyncHttpClientBuilder connectionTimeout(Duration connectionTimeout)

Sets the connection timeout.

If connectionTimeout is null or less than or equal to zero a default timeout of 10 seconds will be used. Otherwise, the maximum of one millisecond and the passed timeout will be used.

Parameters:

connectionTimeout - The connection timeout.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

connectionPool

public OkHttpAsyncHttpClientBuilder connectionPool(okhttp3.ConnectionPool connectionPool)

Sets the Http connection pool.

Parameters:

connectionPool - The OkHttp connection pool to use.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

dispatcher

public OkHttpAsyncHttpClientBuilder dispatcher(okhttp3.Dispatcher dispatcher)

Sets the dispatcher that also composes the thread pool for executing HTTP requests.

Parameters:

dispatcher - The dispatcher to use.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

proxy

public OkHttpAsyncHttpClientBuilder proxy(ProxyOptions proxyOptions)

Sets the proxy.

Parameters:

proxyOptions - The proxy configuration to use.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

configuration

public OkHttpAsyncHttpClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the HTTP client.

The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store.

Returns:

The updated OkHttpAsyncHttpClientBuilder object.

build

public HttpClient build()

Creates a new OkHttp-backed HttpClient instance on every call, using the configuration set in the builder at the time of the build method call.

Returns:

A new OkHttp-backed HttpClient instance.