An XHR transport based on Undertow's io.undertow.client.UndertowClient. Requires Undertow 1.3 or 1.4, including XNIO, as of Spring Framework 5.0.

When used for testing purposes (e.g. 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);

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	UndertowXhrTransport.SockJsResponseListener

Field Summary

Modifier and Type	Field and Description
private final ByteBufferPool	bufferPool
private final UndertowClient	httpClient
private final OptionMap	optionMap
private static final AttachmentKey<String>	RESPONSE_BODY
private final XnioWorker	worker

Inherited from org.springframework.web.socket.sockjs.client.AbstractXhrTransport:: logger PRELUDE

Access	Constructor and Description
public	UndertowXhrTransport()
public	UndertowXhrTransport(OptionMap optionMap)

Method Summary

Modifier and Type	Method and Description
private static void	addHttpHeaders(ClientRequest request, HttpHeaders headers)
protected void	connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.connectInternal.
private ClientCallback<ClientExchange>	createReceiveCallback(final TransportRequest transportRequest, final URI url, final HttpHeaders headers, final XhrClientSockJsSession sockJsSession, final CompletableFuture<WebSocketSession> connectFuture)
private ClientCallback<ClientExchange>	createRequestCallback(final String body, final List<ClientResponse> responses, final CountDownLatch latch)
protected ResponseEntity<String>	executeInfoRequestInternal(URI infoUrl, HttpHeaders headers) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeInfoRequestInternal.
private void	executeReceiveRequest(final TransportRequest transportRequest, final URI url, final HttpHeaders headers, final XhrClientSockJsSession session, final CompletableFuture<WebSocketSession> connectFuture)
protected ResponseEntity<String>	executeRequest(URI url, HttpString method, HttpHeaders headers, String body)
protected ResponseEntity<String>	executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeSendRequestInternal.
public UndertowClient	getHttpClient() Return Undertow's native HTTP client.
public XnioWorker	getWorker() Return the `org.xnio.XnioWorker` backing the I/O operations for Undertow's HTTP client.
private static HttpHeaders	toHttpHeaders(HeaderMap headerMap)

Inherited from org.springframework.web.socket.sockjs.client.AbstractXhrTransport:: connectAsync connectInternal executeInfoRequest executeSendRequest getTransportTypes isXhrStreamingDisabled setXhrStreamingDisabled

Field Detail

bufferPool	back to summary
private final ByteBufferPool bufferPool

httpClient	back to summary
private final UndertowClient httpClient

optionMap	back to summary
private final OptionMap optionMap

RESPONSE_BODY	back to summary
private static final AttachmentKey<String> RESPONSE_BODY

worker	back to summary
private final XnioWorker worker

UndertowXhrTransport	back to summary
public UndertowXhrTransport() throws IOException

UndertowXhrTransport	back to summary
public UndertowXhrTransport(OptionMap optionMap) throws IOException

Method Detail

addHttpHeaders	back to summary
private static void addHttpHeaders(ClientRequest request, HttpHeaders headers)

connectInternal	back to summary
protected void connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.connectInternal. Annotations @Override

connectInternal

back to summary

protected void connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)

Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.connectInternal.

Annotations

@Override

createReceiveCallback	back to summary
private ClientCallback<ClientExchange> createReceiveCallback(final TransportRequest transportRequest, final URI url, final HttpHeaders headers, final XhrClientSockJsSession sockJsSession, final CompletableFuture<WebSocketSession> connectFuture)

createRequestCallback	back to summary
private ClientCallback<ClientExchange> createRequestCallback(final String body, final List<ClientResponse> responses, final CountDownLatch latch)

executeInfoRequestInternal	back to summary
protected ResponseEntity<String> executeInfoRequestInternal(URI infoUrl, HttpHeaders headers) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeInfoRequestInternal. Annotations @Override

executeInfoRequestInternal

back to summary

protected ResponseEntity<String> executeInfoRequestInternal(URI infoUrl, HttpHeaders headers)

Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeInfoRequestInternal.

Annotations

@Override

executeReceiveRequest	back to summary
private void executeReceiveRequest(final TransportRequest transportRequest, final URI url, final HttpHeaders headers, final XhrClientSockJsSession session, final CompletableFuture<WebSocketSession> connectFuture)

executeRequest	back to summary
protected ResponseEntity<String> executeRequest(URI url, HttpString method, HttpHeaders headers, String body)

executeSendRequestInternal	back to summary
protected ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeSendRequestInternal. Annotations @Override

executeSendRequestInternal

back to summary

protected ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message)

Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeSendRequestInternal.

Annotations

@Override

getHttpClient	back to summary
public UndertowClient getHttpClient() Return Undertow's native HTTP client.

getWorker back to summary

getWorker	back to summary
public XnioWorker getWorker() Return the `org.xnio.XnioWorker` backing the I/O operations for Undertow's HTTP client. See Also `org.xnio.Xnio`

public XnioWorker getWorker()

Return the org.xnio.XnioWorker backing the I/O operations for Undertow's HTTP client.

See Also: org.xnio.Xnio

toHttpHeaders	back to summary
private static HttpHeaders toHttpHeaders(HeaderMap headerMap)

org.springframework.web.socket.sockjs.client back to summary

private Class UndertowXhrTransport.SockJsResponseListener

Class Inheritance

extends Object
implements ChannelListener<StreamSourceChannel>

java.lang.Object
org.springframework.web.socket.sockjs.client.UndertowXhrTransport.SockJsResponseListener

All Implemented Interfaces

org.xnio.ChannelListener, java.util.EventListener

Field Summary

Modifier and Type	Field and Description
private final CompletableFuture<WebSocketSession>	connectFuture
private final ClientConnection	connection
private final HttpHeaders	headers
private final ByteArrayOutputStream	outputStream
private final TransportRequest	request
private final XhrClientSockJsSession	session
private final URI	url

Constructor Summary

Access	Constructor and Description
public	SockJsResponseListener(TransportRequest request, ClientConnection connection, URI url, HttpHeaders headers, XhrClientSockJsSession sockJsSession, CompletableFuture<WebSocketSession> connectFuture)

Method Summary

Modifier and Type	Method and Description
public void	handleEvent(StreamSourceChannel the channel event channel) Implements org.xnio.ChannelListener.handleEvent. Handle the event on this channel.
private void	handleFrame()
public void	onFailure(Throwable failure)
public void	onSuccess()
public void	setup(StreamSourceChannel channel)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connectFuture	back to summary
private final CompletableFuture<WebSocketSession> connectFuture

connection	back to summary
private final ClientConnection connection

headers	back to summary
private final HttpHeaders headers

outputStream	back to summary
private final ByteArrayOutputStream outputStream

request	back to summary
private final TransportRequest request

session	back to summary
private final XhrClientSockJsSession session

url	back to summary
private final URI url

Constructor Detail

SockJsResponseListener	back to summary
public SockJsResponseListener(TransportRequest request, ClientConnection connection, URI url, HttpHeaders headers, XhrClientSockJsSession sockJsSession, CompletableFuture<WebSocketSession> connectFuture)

Method Detail

handleEvent	back to summary
public void handleEvent(StreamSourceChannel channel) Implements org.xnio.ChannelListener.handleEvent. Doc from org.xnio.ChannelListener.handleEvent. Handle the event on this channel. Parameters channel:StreamSourceChannel the channel event Annotations @Override

handleEvent

back to summary

public void handleEvent(StreamSourceChannel channel)

Implements org.xnio.ChannelListener.handleEvent.

Doc from org.xnio.ChannelListener.handleEvent.

Handle the event on this channel.

Parameters

channel:StreamSourceChannel: the channel event

Annotations

@Override

handleFrame	back to summary
private void handleFrame()

onFailure	back to summary
public void onFailure(Throwable failure)

onSuccess	back to summary
public void onSuccess()

setup	back to summary
public void setup(StreamSourceChannel channel)

public Class UndertowXhrTransport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class UndertowXhrTransport.SockJsResponseListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail