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

@Deprecated(since="7.1",
            forRemoval=true)
public class RestTemplateXhrTransport
extends AbstractXhrTransport

Deprecated, for removal: This API element is subject to removal in a future version.

as of 7.1 in favor of RestClientXhrTransport.

An XhrTransport implementation that uses a RestTemplate.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class AbstractXhrTransport

logger, PRELUDE

Constructor Summary

Constructors

Constructor	Description
RestTemplateXhrTransport()	Deprecated, for removal: This API element is subject to removal in a future version.
RestTemplateXhrTransport(RestOperations restTemplate)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected void	connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)	Deprecated, for removal: This API element is subject to removal in a future version.
protected ResponseEntity<String>	executeInfoRequestInternal(URI infoUrl, HttpHeaders headers)	Deprecated, for removal: This API element is subject to removal in a future version.
ResponseEntity<String>	executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message)	Deprecated, for removal: This API element is subject to removal in a future version.
RestOperations	getRestTemplate()	Deprecated, for removal: This API element is subject to removal in a future version. Return the configured RestTemplate.
TaskExecutor	getTaskExecutor()	Deprecated, for removal: This API element is subject to removal in a future version. Return the configured TaskExecutor.
void	setTaskExecutor(TaskExecutor taskExecutor)	Deprecated, for removal: This API element is subject to removal in a future version. Configure the TaskExecutor to use to execute XHR receive requests.

Methods inherited from class AbstractXhrTransport

connectAsync, executeInfoRequest, executeSendRequest, getTransportTypes, isXhrStreamingDisabled, setXhrStreamingDisabled

Methods inherited from class Object

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

Constructor Details

RestTemplateXhrTransport

public RestTemplateXhrTransport()

Deprecated, for removal: This API element is subject to removal in a future version.

RestTemplateXhrTransport

public RestTemplateXhrTransport(RestOperations restTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getRestTemplate

public RestOperations getRestTemplate()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the configured RestTemplate.

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the configured TaskExecutor.

connectInternal

protected void connectInternal(TransportRequest transportRequest,
 WebSocketHandler handler,
 URI receiveUrl,
 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 ResponseEntity<String> executeInfoRequestInternal(URI infoUrl,
 HttpHeaders headers)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

executeInfoRequestInternal in class AbstractXhrTransport

executeSendRequestInternal

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

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

executeSendRequestInternal in class AbstractXhrTransport