Top Description Inners Fields Constructors Methods

org.springframework.web.socket.sockjs.client

public Class RestTemplateXhrTransport

Class Inheritance

java.lang.Object
org.springframework.web.socket.sockjs.client.AbstractXhrTransport
org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

Imports

An XhrTransport implementation that uses a RestTemplate.

Author: Rossen Stoyanchev
Since: 4.1

Nested and Inner Type Summary

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

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

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

Constructor Summary

Access	Constructor and Description
public	RestTemplateXhrTransport()
public	RestTemplateXhrTransport(RestOperations restTemplate)

Method Summary

Modifier and Type	Method and Description
protected void	connectInternal(final TransportRequest transportRequest, final WebSocketHandler handler, final URI receiveUrl, final HttpHeaders handshakeHeaders, final XhrClientSockJsSession session, final CompletableFuture<WebSocketSession> connectFuture) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.connectInternal.
protected ResponseEntity<String>	executeInfoRequestInternal(URI infoUrl, HttpHeaders headers) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeInfoRequestInternal.
public ResponseEntity<String>	executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message) Implements abstract org.springframework.web.socket.sockjs.client.AbstractXhrTransport.executeSendRequestInternal.
public RestOperations	getRestTemplate() Return the configured `RestTemplate`.
public TaskExecutor	getTaskExecutor() Return the configured `TaskExecutor`.
private static <T> T	nonNull(T result)
public void	setTaskExecutor(TaskExecutor taskExecutor) Configure the `TaskExecutor` to use to execute XHR receive requests.

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

Field Detail

restTemplate	back to summary
private final RestOperations restTemplate

taskExecutor	back to summary
private TaskExecutor taskExecutor

textResponseExtractor	back to summary
private static final ResponseExtractor<ResponseEntity<String>> textResponseExtractor A simple ResponseExtractor that reads the body into a String.

Constructor Detail

RestTemplateXhrTransport	back to summary
public RestTemplateXhrTransport()

RestTemplateXhrTransport	back to summary
public RestTemplateXhrTransport(RestOperations restTemplate)

Method Detail

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

connectInternal

back to summary

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

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

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

executeInfoRequestInternal

back to summary

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

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

Annotations

@Override

executeSendRequestInternal	back to summary
public 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

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

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

Annotations

@Override

getRestTemplate	back to summary
public RestOperations getRestTemplate() Return the configured `RestTemplate`.

getTaskExecutor	back to summary
public TaskExecutor getTaskExecutor() Return the configured `TaskExecutor`.

nonNull	back to summary
private static <T> T nonNull(T result)

setTaskExecutor back to summary

setTaskExecutor	back to summary
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.

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.

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

private Class RestTemplateXhrTransport.XhrReceiveExtractor

Class Inheritance

extends Object
implements ResponseExtractor<Object>

java.lang.Object
org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport.XhrReceiveExtractor

All Implemented Interfaces

org.springframework.web.client.ResponseExtractor

Splits the body of an HTTP response into SockJS frames and delegates those to an XhrClientSockJsSession.

Field Summary

Modifier and Type	Field and Description
private final XhrClientSockJsSession	sockJsSession

Constructor Summary

Access	Constructor and Description
public	XhrReceiveExtractor(XhrClientSockJsSession sockJsSession)

Method Summary

Modifier and Type	Method and Description
public Object	extractData(ClientHttpResponse the HTTP response response) Implements org.springframework.web.client.ResponseExtractor.extractData. Extract data from the given `ClientHttpResponse` and return it.
private void	handleFrame(ByteArrayOutputStream os)

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

Field Detail

sockJsSession	back to summary
private final XhrClientSockJsSession sockJsSession

Constructor Detail

XhrReceiveExtractor	back to summary
public XhrReceiveExtractor(XhrClientSockJsSession sockJsSession)

Method Detail

extractData back to summary

extractData	back to summary
public Object extractData(ClientHttpResponse response) throws IOException Implements org.springframework.web.client.ResponseExtractor.extractData. Doc from org.springframework.web.client.ResponseExtractor.extractData. Extract data from the given `ClientHttpResponse` and return it. Parameters response:ClientHttpResponse the HTTP response Returns:Object the extracted data Annotations @Override Exceptions IOException: in case of I/O errors

public Object extractData(ClientHttpResponse response) throws IOException

Implements org.springframework.web.client.ResponseExtractor.extractData.

Doc from org.springframework.web.client.ResponseExtractor.extractData.

Extract data from the given ClientHttpResponse and return it.

Parameters

response:ClientHttpResponse: the HTTP response

Returns:Object

the extracted data

Annotations

@Override

Exceptions

IOException:: in case of I/O errors

handleFrame	back to summary
private void handleFrame(ByteArrayOutputStream os)

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

private Class RestTemplateXhrTransport.XhrRequestCallback

Class Inheritance

extends Object
implements RequestCallback

java.lang.Object
org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport.XhrRequestCallback

All Implemented Interfaces

org.springframework.web.client.RequestCallback

A RequestCallback to add the headers and (optionally) String content.

Field Summary

Modifier and Type	Field and Description
private final String	body
private final HttpHeaders	headers

Constructor Summary

Access	Constructor and Description
public	XhrRequestCallback(HttpHeaders headers)
public	XhrRequestCallback(HttpHeaders headers, String body)

Method Summary

Modifier and Type	Method and Description
public void	doWithRequest(ClientHttpRequest the active HTTP request request) Implements org.springframework.web.client.RequestCallback.doWithRequest. Gets called by `RestTemplate#execute` with an opened `ClientHttpRequest`.

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

Field Detail

body	back to summary
private final String body Annotations @Nullable

headers	back to summary
private final HttpHeaders headers

Constructor Detail

XhrRequestCallback	back to summary
public XhrRequestCallback(HttpHeaders headers)

XhrRequestCallback	back to summary
public XhrRequestCallback(HttpHeaders headers, String body)

Method Detail

doWithRequest back to summary

doWithRequest	back to summary
public void doWithRequest(ClientHttpRequest request) throws IOException Implements org.springframework.web.client.RequestCallback.doWithRequest. Doc from org.springframework.web.client.RequestCallback.doWithRequest. Gets called by `RestTemplate#execute` with an opened `ClientHttpRequest`. Does not need to care about closing the request or about handling errors: this will all be handled by the `RestTemplate`. Parameters request:ClientHttpRequest the active HTTP request Annotations @Override Exceptions IOException: in case of I/O errors

public void doWithRequest(ClientHttpRequest request) throws IOException

Implements org.springframework.web.client.RequestCallback.doWithRequest.

Doc from org.springframework.web.client.RequestCallback.doWithRequest.

Gets called by RestTemplate#execute with an opened ClientHttpRequest. Does not need to care about closing the request or about handling errors: this will all be handled by the RestTemplate.

Parameters

request:ClientHttpRequest: the active HTTP request

Annotations

@Override

Exceptions

IOException:: in case of I/O errors