org.springframework.http.client

Class OkHttpClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.OkHttpClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, AsyncClientHttpRequestFactory, ClientHttpRequestFactory

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

ClientHttpRequestFactory implementation that uses OkHttp to create requests.

Since:

4.2

Author:

Luciano Leggieri, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private OkHttpClient	client
private boolean	defaultClient

Constructor Summary

Constructors

Constructor and Description
OkHttpClientHttpRequestFactory() Create a factory with a default OkHttpClient instance.
OkHttpClientHttpRequestFactory(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.
private OkHttpClientHttpRequest	createRequestInternal(java.net.URI uri, HttpMethod httpMethod)
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

Field Detail

client

private final OkHttpClient client

defaultClient

private final boolean defaultClient

Constructor Detail

OkHttpClientHttpRequestFactory

public OkHttpClientHttpRequestFactory()

Create a factory with a default OkHttpClient instance.

OkHttpClientHttpRequestFactory

public OkHttpClientHttpRequestFactory(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#setReadTimeout(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#setWriteTimeout(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#setConnectTimeout(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

createRequestInternal

private OkHttpClientHttpRequest createRequestInternal(java.net.URI uri,
                                                      HttpMethod httpMethod)

destroy

public void destroy()
             throws java.lang.Exception

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean

Throws:

java.lang.Exception - in case of shutdown errors. Exceptions will get logged but not rethrown to allow other beans to release their resources too.