Package org.springframework.web.socket.sockjs.client

Class UndertowXhrTransport

java.lang.Object
org.springframework.web.socket.sockjs.client.AbstractXhrTransport
org.springframework.web.socket.sockjs.client.UndertowXhrTransport
All Implemented Interfaces:
InfoReceiver, Transport, XhrTransport
@Deprecated(since="6.2.18", forRemoval=true) public class UndertowXhrTransport extends AbstractXhrTransport
Deprecated, for removal: This API element is subject to removal in a future version.
as of 6.2.18 with no replacement
An XHR transport based on Undertow's UndertowClient.

Requires Undertow 1.3 or 1.4, including XNIO.

When used for testing purposes (for example, load testing) or for specific use cases (like HTTPS configuration), a custom OptionMap should be provided: 

 OptionMap optionMap = OptionMap.builder()
   .set(Options.WORKER_IO_THREADS, 8)
   .set(Options.TCP_NODELAY, true)
   .set(Options.KEEP_ALIVE, true)
   .set(Options.WORKER_NAME, "SockJSClient")
   .getMap();

 UndertowXhrTransport transport = new UndertowXhrTransport(optionMap);
Since:
4.1.2
Author:
Brian Clozel, Rossen Stoyanchev
See Also:
  • Options

  • Constructor Details

    • UndertowXhrTransport

      public UndertowXhrTransport() throws IOException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      IOException

    • UndertowXhrTransport

      public UndertowXhrTransport(org.xnio.OptionMap optionMap) throws IOException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      IOException

  • Method Details

    • getHttpClient

      public io.undertow.client.UndertowClient getHttpClient()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return Undertow's native HTTP client.

    • getWorker

      public org.xnio.XnioWorker getWorker()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the XnioWorker backing the I/O operations for Undertow's HTTP client.
      See Also:
      • Xnio

    • connectInternal

      protected void connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, org.springframework.http.HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      connectInternal in class AbstractXhrTransport

    • executeInfoRequestInternal

      protected org.springframework.http.ResponseEntity<String> executeInfoRequestInternal(URI infoUrl, org.springframework.http.HttpHeaders headers)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      executeInfoRequestInternal in class AbstractXhrTransport

    • executeSendRequestInternal

      protected org.springframework.http.ResponseEntity<String> executeSendRequestInternal(URI url, org.springframework.http.HttpHeaders headers, TextMessage message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      executeSendRequestInternal in class AbstractXhrTransport

    • executeRequest

      protected org.springframework.http.ResponseEntity<String> executeRequest(URI url, io.undertow.util.HttpString method, org.springframework.http.HttpHeaders headers, @Nullable String body)
      Deprecated, for removal: This API element is subject to removal in a future version.