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
implements XhrTransport

An XhrTransport implementation that uses a RestTemplate.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

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, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)
protected ResponseEntity<String>	executeInfoRequestInternal(URI infoUrl, HttpHeaders headers)
ResponseEntity<String>	executeSendRequestInternal(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

Methods inherited from interface org.springframework.web.socket.sockjs.client.XhrTransport

executeSendRequest, isXhrStreamingDisabled

Methods inherited from interface org.springframework.web.socket.sockjs.client.Transport

connect, getTransportTypes

Methods inherited from interface org.springframework.web.socket.sockjs.client.InfoReceiver

executeInfoRequest

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,
                               URI receiveUrl,
                               HttpHeaders handshakeHeaders,
                               XhrClientSockJsSession session,
                               SettableListenableFuture<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