Package org.springframework.http.client

Class OkHttp3ClientHttpRequestFactory

java.lang.Object
org.springframework.http.client.OkHttp3ClientHttpRequestFactory
All Implemented Interfaces:
Closeable, AutoCloseable, 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 Details

    • 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 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

      public ClientHttpRequest createRequest(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

    • destroy

      public void destroy() throws IOException
      Description copied from interface: DisposableBean
      Invoked by the containing BeanFactory on destruction of a bean.
      Specified by:
      destroy in interface DisposableBean
      Throws:
      IOException

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface ClientHttpRequestFactory
      Specified by:
      close in interface Closeable
      Throws:
      IOException