Package org.springframework.http.client
Class OkHttp3ClientHttpRequestFactory
java.lang.Object
org.springframework.http.client.OkHttp3ClientHttpRequestFactory
- All Implemented Interfaces:
DisposableBean,ClientHttpRequestFactory
public class OkHttp3ClientHttpRequestFactory
extends Object
implements ClientHttpRequestFactory, DisposableBean
ClientHttpRequestFactory implementation that uses
OkHttp 3.x to create requests.- Since:
- 4.3
- Author:
- Luciano Leggieri, Arjen Poutsma, Roy Clarkson
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a factory with a defaultOkHttpClientinstance.OkHttp3ClientHttpRequestFactory(okhttp3.OkHttpClient client) Create a factory with the givenOkHttpClientinstance. -
Method Summary
Modifier and TypeMethodDescriptioncreateRequest(URI uri, HttpMethod httpMethod) Create a newClientHttpRequestfor the specified URI and HTTP method.voiddestroy()Invoked by the containingBeanFactoryon destruction of a bean.voidsetConnectTimeout(int connectTimeout) Set the underlying connect timeout in milliseconds.voidsetReadTimeout(int readTimeout) Set the underlying read timeout in milliseconds.voidsetWriteTimeout(int writeTimeout) Set the underlying write timeout in milliseconds.
-
Constructor Details
-
OkHttp3ClientHttpRequestFactory
public OkHttp3ClientHttpRequestFactory()Create a factory with a defaultOkHttpClientinstance. -
OkHttp3ClientHttpRequestFactory
public OkHttp3ClientHttpRequestFactory(okhttp3.OkHttpClient client) Create a factory with the givenOkHttpClientinstance.- Parameters:
client- the client to use
-
-
Method Details
-
setReadTimeout
public void setReadTimeout(int readTimeout) Set the underlying read timeout in milliseconds. A value of 0 specifies an infinite timeout. -
setWriteTimeout
public void setWriteTimeout(int writeTimeout) Set the underlying write timeout in milliseconds. A value of 0 specifies an infinite timeout. -
setConnectTimeout
public void setConnectTimeout(int connectTimeout) Set the underlying connect timeout in milliseconds. A value of 0 specifies an infinite timeout. -
createRequest
Description copied from interface:ClientHttpRequestFactoryCreate a newClientHttpRequestfor the specified URI and HTTP method.The returned request can be written to, and then executed by calling
ClientHttpRequest.execute().- Specified by:
createRequestin interfaceClientHttpRequestFactory- Parameters:
uri- the URI to create a request forhttpMethod- the HTTP method to execute- Returns:
- the created request
-
destroy
Description copied from interface:DisposableBeanInvoked by the containingBeanFactoryon destruction of a bean.- Specified by:
destroyin interfaceDisposableBean- Throws:
IOException
-