org.springframework.http.client

Class OkHttp3ClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.OkHttp3ClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, AsyncClientHttpRequestFactory, ClientHttpRequestFactory

public class OkHttp3ClientHttpRequestFactory
extends java.lang.Object
implements ClientHttpRequestFactory, AsyncClientHttpRequestFactory, DisposableBean

ClientHttpRequestFactory implementation that uses OkHttp 3.x to create requests.

Since:

4.3

Author:

Luciano Leggieri, Arjen Poutsma, Roy Clarkson

Constructor Summary

Constructors

Constructor and Description
OkHttp3ClientHttpRequestFactory() Create a factory with a default OkHttpClient instance.
OkHttp3ClientHttpRequestFactory(okhttp3.OkHttpClient client) Create a factory with the given OkHttpClient instance.

Method Summary

Modifier and Type	Method and Description
AsyncClientHttpRequest	createAsyncRequest(java.net.URI uri, HttpMethod httpMethod) Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.
ClientHttpRequest	createRequest(java.net.URI uri, HttpMethod httpMethod) Create a new ClientHttpRequest for the specified URI and HTTP method.
void	destroy() Invoked by a BeanFactory on destruction of a singleton.
void	setConnectTimeout(int connectTimeout) Sets the underlying connect timeout in milliseconds.
void	setReadTimeout(int readTimeout) Sets the underlying read timeout in milliseconds.
void	setWriteTimeout(int writeTimeout) Sets the underlying write timeout in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttp3ClientHttpRequestFactory

public OkHttp3ClientHttpRequestFactory()

Create a factory with a default OkHttpClient instance.

OkHttp3ClientHttpRequestFactory

public OkHttp3ClientHttpRequestFactory(okhttp3.OkHttpClient client)

Create a factory with the given OkHttpClient instance.

Parameters:

client - the client to use

Method Detail

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets the underlying read timeout in milliseconds. A value of 0 specifies an infinite timeout.

See Also:

OkHttpClient.Builder#readTimeout(long, TimeUnit)

setWriteTimeout

public void setWriteTimeout(int writeTimeout)

Sets the underlying write timeout in milliseconds. A value of 0 specifies an infinite timeout.

See Also:

OkHttpClient.Builder#writeTimeout(long, TimeUnit)

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Sets the underlying connect timeout in milliseconds. A value of 0 specifies an infinite timeout.

See Also:

OkHttpClient.Builder#connectTimeout(long, TimeUnit)

createRequest

public ClientHttpRequest createRequest(java.net.URI uri,
                                       HttpMethod httpMethod)

Description copied from interface: ClientHttpRequestFactory

Create a new ClientHttpRequest for the specified URI and HTTP method.

The returned request can be written to, and then executed by calling ClientHttpRequest.execute().

Specified by:

createRequest in interface ClientHttpRequestFactory

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

Returns:

the created request

createAsyncRequest

public AsyncClientHttpRequest createAsyncRequest(java.net.URI uri,
                                                 HttpMethod httpMethod)

Description copied from interface: AsyncClientHttpRequestFactory

Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.

The returned request can be written to, and then executed by calling AsyncClientHttpRequest.executeAsync().

Specified by:

createAsyncRequest in interface AsyncClientHttpRequestFactory

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

Returns:

the created request

destroy

public void destroy()
             throws java.io.IOException

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean

Throws:

java.io.IOException