org.springframework.web.socket.sockjs.client

Class RestTemplateXhrTransport

java.lang.Object

org.springframework.web.socket.sockjs.client.AbstractXhrTransport

org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

All Implemented Interfaces:

InfoReceiver, Transport, XhrTransport

public class RestTemplateXhrTransport
extends AbstractXhrTransport

An XhrTransport implementation that uses a RestTemplate.

Since:

4.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RestTemplateXhrTransport.XhrReceiveExtractor Splits the body of an HTTP response into SockJS frames and delegates those to an XhrClientSockJsSession.
private static class	RestTemplateXhrTransport.XhrRequestCallback A RequestCallback to add the headers and (optionally) String content.

Field Summary

Fields

Modifier and Type	Field and Description
private RestOperations	restTemplate
private TaskExecutor	taskExecutor
private static ResponseExtractor<ResponseEntity<java.lang.String>>	textResponseExtractor A simple ResponseExtractor that reads the body into a String.

Fields inherited from class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

logger, PRELUDE

Constructor Summary

Constructors

Constructor and Description
RestTemplateXhrTransport()
RestTemplateXhrTransport(RestOperations restTemplate)

Method Summary

Modifier and Type	Method and Description
protected void	connectInternal(TransportRequest transportRequest, WebSocketHandler handler, java.net.URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)
protected ResponseEntity<java.lang.String>	executeInfoRequestInternal(java.net.URI infoUrl, HttpHeaders headers)
ResponseEntity<java.lang.String>	executeSendRequestInternal(java.net.URI url, HttpHeaders headers, TextMessage message)
RestOperations	getRestTemplate() Return the configured RestTemplate.
TaskExecutor	getTaskExecutor() Return the configured TaskExecutor.
void	setTaskExecutor(TaskExecutor taskExecutor) Configure the TaskExecutor to use to execute XHR receive requests.

Methods inherited from class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

connect, executeInfoRequest, executeSendRequest, getRequestHeaders, getTransportTypes, isXhrStreamingDisabled, setRequestHeaders, setXhrStreamingDisabled, toString

Methods inherited from class java.lang.Object

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

Field Detail

restTemplate

private final RestOperations restTemplate

taskExecutor

private TaskExecutor taskExecutor

textResponseExtractor

private static final ResponseExtractor<ResponseEntity<java.lang.String>> textResponseExtractor

A simple ResponseExtractor that reads the body into a String.

Constructor Detail

RestTemplateXhrTransport

public RestTemplateXhrTransport()

RestTemplateXhrTransport

public RestTemplateXhrTransport(RestOperations restTemplate)

Method Detail

getRestTemplate

public RestOperations getRestTemplate()

Return the configured RestTemplate.

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

Configure the TaskExecutor to use to execute XHR receive requests.

By default SimpleAsyncTaskExecutor is configured which creates a new thread every time the transports connects.

getTaskExecutor

public TaskExecutor getTaskExecutor()

Return the configured TaskExecutor.

connectInternal

protected void connectInternal(TransportRequest transportRequest,
                               WebSocketHandler handler,
                               java.net.URI receiveUrl,
                               HttpHeaders handshakeHeaders,
                               XhrClientSockJsSession session,
                               SettableListenableFuture<WebSocketSession> connectFuture)

Specified by:

connectInternal in class AbstractXhrTransport

executeInfoRequestInternal

protected ResponseEntity<java.lang.String> executeInfoRequestInternal(java.net.URI infoUrl,
                                                                      HttpHeaders headers)

Specified by:

executeInfoRequestInternal in class AbstractXhrTransport

executeSendRequestInternal

public ResponseEntity<java.lang.String> executeSendRequestInternal(java.net.URI url,
                                                                   HttpHeaders headers,
                                                                   TextMessage message)

Specified by:

executeSendRequestInternal in class AbstractXhrTransport