Package org.springframework.http.client

Class ReactorNettyClientRequestFactory

java.lang.Object
org.springframework.http.client.ReactorNettyClientRequestFactory
All Implemented Interfaces:
Lifecycle, Phased, SmartLifecycle, ClientHttpRequestFactory
public class ReactorNettyClientRequestFactory extends Object implements ClientHttpRequestFactory, 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()
      Description copied from interface: Lifecycle
      Start this component.

      Should not throw an exception if the component is already running.

      In the case of a container, this will propagate the start signal to all components that apply.

      Specified by:
      start in interface Lifecycle
      See Also:

    • stop

      public void stop()
      Description copied from interface: Lifecycle
      Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

      Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

      Should not throw an exception if the component is not running (not started yet).

      In the case of a container, this will propagate the stop signal to all components that apply.

      Specified by:
      stop in interface Lifecycle
      See Also:

    • stop

      public final void stop(Runnable callback)
      Description copied from interface: SmartLifecycle
      Indicates that a Lifecycle component must stop if it is currently running.

      The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.

      The LifecycleProcessor will call only this variant of the stop method; i.e. Lifecycle.stop() will not be called for SmartLifecycle implementations unless explicitly delegated to within the implementation of this method.

      The default implementation delegates to Lifecycle.stop() and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any).

      Specified by:
      stop in interface SmartLifecycle
      See Also:

    • isRunning

      public boolean isRunning()
      Description copied from interface: Lifecycle
      Check whether this component is currently running.

      In the case of a container, this will return true only if all components that apply are currently running.

      Specified by:
      isRunning in interface Lifecycle
      Returns:
      whether the component is currently running

    • isAutoStartup

      public boolean isAutoStartup()
      Description copied from interface: SmartLifecycle
      Returns true if this Lifecycle component should get started automatically by the container at the time that the containing ApplicationContext gets refreshed.

      A value of false indicates that the component is intended to be started through an explicit Lifecycle.start() call instead, analogous to a plain Lifecycle implementation.

      The default implementation returns true.

      Specified by:
      isAutoStartup in interface SmartLifecycle
      See Also:

    • getPhase

      public int getPhase()
      Description copied from interface: SmartLifecycle
      Return the phase that this lifecycle object is supposed to run in.

      The default implementation returns SmartLifecycle.DEFAULT_PHASE in order to let stop() callbacks execute before regular Lifecycle implementations.

      Specified by:
      getPhase in interface Phased
      Specified by:
      getPhase in interface SmartLifecycle
      See Also: