Package org.springframework.http.client

Class ReactorNettyClientRequestFactory

java.lang.Object
org.springframework.http.client.ReactorNettyClientRequestFactory
All Implemented Interfaces:
org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ClientHttpRequestFactory
public class ReactorNettyClientRequestFactory extends Object implements ClientHttpRequestFactory, org.springframework.context.SmartLifecycle
Reactor-Netty implementation of ClientHttpRequestFactory.

This class implements SmartLifecycle and can be optionally declared as a Spring-managed bean in order to support JVM Checkpoint Restore.

Since:
6.1
Author:
Arjen Poutsma, Sebastien Deleuze

  • Constructor Details

    • ReactorNettyClientRequestFactory

      public ReactorNettyClientRequestFactory()
      Create a new instance of the ReactorNettyClientRequestFactory with a default HttpClient that has compression enabled.

    • ReactorNettyClientRequestFactory

      public ReactorNettyClientRequestFactory(reactor.netty.http.client.HttpClient httpClient)
      Create a new instance of the ReactorNettyClientRequestFactory based on the given HttpClient.
      Parameters:
      httpClient - the client to base on

    • ReactorNettyClientRequestFactory

      public ReactorNettyClientRequestFactory(ReactorResourceFactory resourceFactory, Function<reactor.netty.http.client.HttpClient,reactor.netty.http.client.HttpClient> mapper)
      Constructor with externally managed Reactor Netty resources, including LoopResources for event loop threads, and ConnectionProvider for the connection pool.

      This constructor should be used only when you don't want the client to participate in the Reactor Netty global resources. By default the client participates in the Reactor Netty global resources held in HttpResources, which is recommended since fixed, shared resources are favored for event loop concurrency. However, consider declaring a ReactorResourceFactory bean with globalResources=true in order to ensure the Reactor Netty global resources are shut down when the Spring ApplicationContext is stopped or closed and restarted properly when the Spring ApplicationContext is (with JVM Checkpoint Restore for example).

      Parameters:
      resourceFactory - the resource factory to obtain the resources from
      mapper - a mapper for further initialization of the created client

  • Method Details

    • setConnectTimeout

      public void setConnectTimeout(int connectTimeout)
      Set the underlying connect timeout in milliseconds. A value of 0 specifies an infinite timeout.

      Default is 30 seconds.

      See Also:
      • Transport.option(ChannelOption, Object)
      • ChannelOption.CONNECT_TIMEOUT_MILLIS

    • setConnectTimeout

      public void setConnectTimeout(Duration connectTimeout)
      Set the underlying connect timeout in milliseconds. A value of 0 specifies an infinite timeout.

      Default is 30 seconds.

      See Also:
      • Transport.option(ChannelOption, Object)
      • ChannelOption.CONNECT_TIMEOUT_MILLIS

    • setReadTimeout

      public void setReadTimeout(long readTimeout)
      Set the underlying read timeout in milliseconds.

      Default is 10 seconds.

    • setReadTimeout

      public void setReadTimeout(Duration readTimeout)
      Set the underlying read timeout as Duration.

      Default is 10 seconds.

    • setExchangeTimeout

      public void setExchangeTimeout(long exchangeTimeout)
      Set the timeout for the HTTP exchange in milliseconds.

      Default is 30 seconds.

    • setExchangeTimeout

      public void setExchangeTimeout(Duration exchangeTimeout)
      Set the timeout for the HTTP exchange.

      Default is 30 seconds.

    • createRequest

      public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException
      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
      Throws:
      IOException - in case of I/O errors

    • start

      public void start()
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Specified by:
      stop in interface org.springframework.context.Lifecycle

    • stop

      public final void stop(Runnable callback)
      Specified by:
      stop in interface org.springframework.context.SmartLifecycle

    • isRunning

      public boolean isRunning()
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle

    • isAutoStartup

      public boolean isAutoStartup()
      Specified by:
      isAutoStartup in interface org.springframework.context.SmartLifecycle

    • getPhase

      public int getPhase()
      Specified by:
      getPhase in interface org.springframework.context.Phased
      Specified by:
      getPhase in interface org.springframework.context.SmartLifecycle