Class JettyXhrTransport

java.lang.Object
org.springframework.web.socket.sockjs.client.AbstractXhrTransport
org.springframework.web.socket.sockjs.client.JettyXhrTransport
All Implemented Interfaces:
Lifecycle, InfoReceiver, Transport, XhrTransport

public class JettyXhrTransport extends AbstractXhrTransport implements Lifecycle
An XHR transport based on Jetty's HttpClient.

When used for testing purposes (e.g. load testing) the HttpClient properties must be set to allow a larger than usual number of connections and threads. For example:

 HttpClient httpClient = new HttpClient();
 httpClient.setMaxConnectionsPerDestination(1000);
 httpClient.setExecutor(new QueuedThreadPool(500));
 
Since:
4.1
Author:
Rossen Stoyanchev
  • Constructor Details

    • JettyXhrTransport

      public JettyXhrTransport(org.eclipse.jetty.client.HttpClient httpClient)
  • Method Details

    • getHttpClient

      public org.eclipse.jetty.client.HttpClient getHttpClient()
    • 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
    • connectInternal

      protected void connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
      Specified by:
      connectInternal in class AbstractXhrTransport
    • executeInfoRequestInternal

      protected ResponseEntity<String> executeInfoRequestInternal(URI infoUrl, HttpHeaders headers)
      Specified by:
      executeInfoRequestInternal in class AbstractXhrTransport
    • executeSendRequestInternal

      public ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message)
      Specified by:
      executeSendRequestInternal in class AbstractXhrTransport
    • executeRequest

      protected ResponseEntity<String> executeRequest(URI url, org.eclipse.jetty.http.HttpMethod method, HttpHeaders headers, @Nullable String body)