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

Class JettyWebSocketClient

java.lang.Object
org.springframework.web.reactive.socket.client.JettyWebSocketClient
All Implemented Interfaces:
org.springframework.context.Lifecycle, WebSocketClient
@Deprecated(since="6.0.3", forRemoval=true) public class JettyWebSocketClient extends Object implements WebSocketClient, org.springframework.context.Lifecycle
Deprecated, for removal: This API element is subject to removal in a future version.
as of 6.0.3, in favor of StandardWebSocketClient
A WebSocketClient implementation for use with Jetty WebSocketClient. Only supported on Jetty 11, superseded by StandardWebSocketClient.

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 Summary

    Constructors
    Constructor
    Description
    JettyWebSocketClient()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Default constructor that creates and manages an instance of a Jetty WebSocketClient.
    JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor that accepts an existing instance of a Jetty WebSocketClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    reactor.core.publisher.Mono<Void>
    execute(URI url, org.springframework.http.HttpHeaders headers, WebSocketHandler handler)
    Deprecated, for removal: This API element is subject to removal in a future version.
    A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.
    reactor.core.publisher.Mono<Void>
    execute(URI url, WebSocketHandler handler)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
    org.eclipse.jetty.websocket.client.WebSocketClient
    getJettyClient()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the underlying Jetty WebSocketClient.
    boolean
    isRunning()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    start()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    stop()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JettyWebSocketClient

      public JettyWebSocketClient()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the underlying Jetty WebSocketClient.

    • start

      public void start()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      stop in interface org.springframework.context.Lifecycle

    • isRunning

      public boolean isRunning()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle

    • execute

      public reactor.core.publisher.Mono<Void> execute(URI url, WebSocketHandler handler)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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, org.springframework.http.HttpHeaders headers, WebSocketHandler handler)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.