Package org.springframework.web.reactive.socket.client

Class JettyWebSocketClient

java.lang.Object
org.springframework.web.reactive.socket.client.JettyWebSocketClient
All Implemented Interfaces:
Lifecycle, WebSocketClient
public class JettyWebSocketClient extends Object implements WebSocketClient, Lifecycle
A WebSocketClient implementation for use with Jetty WebSocketClient.

Note: the Jetty WebSocketClient requires lifecycle management and must be started and stopped. This is automatically managed when this class is declared as a Spring bean and created with the default constructor. See constructor notes for more details.

Since:
5.0
Author:
Violeta Georgieva, Rossen Stoyanchev, Juergen Hoeller

  • Constructor Details

    • JettyWebSocketClient

      public JettyWebSocketClient()
      Default constructor that creates and manages an instance of a Jetty WebSocketClient. The instance can be obtained with getJettyClient() for further configuration.

      Note: When this constructor is used Lifecycle methods of this class are delegated to the Jetty WebSocketClient.

    • JettyWebSocketClient

      public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient)
      Constructor that accepts an existing instance of a Jetty WebSocketClient.

      Note: Use of this constructor implies the Jetty WebSocketClient is externally managed and hence Lifecycle methods of this class are not delegated to it.

  • Method Details

    • getJettyClient

      public org.eclipse.jetty.websocket.client.WebSocketClient getJettyClient()
      Return the underlying Jetty WebSocketClient.

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

    • 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

    • execute

      public reactor.core.publisher.Mono<Void> execute(URI url, WebSocketHandler handler)
      Description copied from interface: WebSocketClient
      Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
      Specified by:
      execute in interface WebSocketClient
      Parameters:
      url - the handshake url
      handler - the handler of the WebSocket session
      Returns:
      completion Mono<Void> to indicate the outcome of the WebSocket session handling.

    • execute

      public reactor.core.publisher.Mono<Void> execute(URI url, HttpHeaders headers, WebSocketHandler handler)
      Description copied from interface: WebSocketClient
      A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.
      Specified by:
      execute in interface WebSocketClient
      Parameters:
      url - the handshake url
      headers - custom headers for the handshake request
      handler - the handler of the WebSocket session
      Returns:
      completion Mono<Void> to indicate the outcome of the WebSocket session handling.