org.springframework.web.socket.sockjs.client

Class AbstractXhrTransport

java.lang.Object

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

All Implemented Interfaces:

InfoReceiver, Transport, XhrTransport

Direct Known Subclasses:

JettyXhrTransport, RestTemplateXhrTransport, UndertowXhrTransport

public abstract class AbstractXhrTransport
extends java.lang.Object
implements XhrTransport

Abstract base class for XHR transport implementations to extend.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger
protected static java.lang.String	PRELUDE
private HttpHeaders	requestHeaders
private HttpHeaders	xhrSendRequestHeaders
private boolean	xhrStreamingDisabled

Constructor Summary

Constructors

Constructor and Description
AbstractXhrTransport()

Method Summary

Modifier and Type	Method and Description
ListenableFuture<WebSocketSession>	connect(TransportRequest request, WebSocketHandler handler) Connect the transport.
protected abstract void	connectInternal(TransportRequest request, WebSocketHandler handler, java.net.URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)
java.lang.String	executeInfoRequest(java.net.URI infoUrl) Perform an HTTP request to the SockJS "Info" URL.
protected abstract ResponseEntity<java.lang.String>	executeInfoRequestInternal(java.net.URI infoUrl)
void	executeSendRequest(java.net.URI url, TextMessage message) Execute a request to send the message to the server.
protected abstract ResponseEntity<java.lang.String>	executeSendRequestInternal(java.net.URI url, HttpHeaders headers, TextMessage message)
HttpHeaders	getRequestHeaders()
java.util.List<TransportType>	getTransportTypes() Return the SockJS transport types that this transport can be used for.
boolean	isXhrStreamingDisabled() Whether XHR streaming is disabled or not.
void	setRequestHeaders(HttpHeaders requestHeaders) Configure headers to be added to every executed HTTP request.
void	setXhrStreamingDisabled(boolean disabled) An XhrTransport can support both the "xhr_streaming" and "xhr" SockJS server transports.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PRELUDE

protected static final java.lang.String PRELUDE

logger

protected Log logger

xhrStreamingDisabled

private boolean xhrStreamingDisabled

requestHeaders

private HttpHeaders requestHeaders

xhrSendRequestHeaders

private HttpHeaders xhrSendRequestHeaders

Constructor Detail

AbstractXhrTransport

public AbstractXhrTransport()

Method Detail

getTransportTypes

public java.util.List<TransportType> getTransportTypes()

Description copied from interface: Transport

Return the SockJS transport types that this transport can be used for. In particular since from a client perspective there is no difference between XHR and XHR streaming, an XhrTransport could do both.

Specified by:

getTransportTypes in interface Transport

setXhrStreamingDisabled

public void setXhrStreamingDisabled(boolean disabled)

An XhrTransport can support both the "xhr_streaming" and "xhr" SockJS server transports. From a client perspective there is no implementation difference.

Typically an XhrTransport is used as "XHR streaming" first and then, if that fails, as "XHR". In some cases however it may be helpful to suppress XHR streaming so that only XHR is attempted.

By default this property is set to false which means both "XHR streaming" and "XHR" apply.

isXhrStreamingDisabled

public boolean isXhrStreamingDisabled()

Whether XHR streaming is disabled or not.

Specified by:

isXhrStreamingDisabled in interface XhrTransport

setRequestHeaders

public void setRequestHeaders(HttpHeaders requestHeaders)

Configure headers to be added to every executed HTTP request.

Parameters:

requestHeaders - the headers to add to requests

getRequestHeaders

public HttpHeaders getRequestHeaders()

executeInfoRequest

public java.lang.String executeInfoRequest(java.net.URI infoUrl)

Description copied from interface: InfoReceiver

Perform an HTTP request to the SockJS "Info" URL. and return the resulting JSON response content, or raise an exception.

Specified by:

executeInfoRequest in interface InfoReceiver

Parameters:

infoUrl - the URL to obtain SockJS server information from

Returns:

the body of the response

executeInfoRequestInternal

protected abstract ResponseEntity<java.lang.String> executeInfoRequestInternal(java.net.URI infoUrl)

executeSendRequest

public void executeSendRequest(java.net.URI url,
                               TextMessage message)

Description copied from interface: XhrTransport

Execute a request to send the message to the server.

Specified by:

executeSendRequest in interface XhrTransport

Parameters:

url - the URL for sending messages.

message - the message to send

executeSendRequestInternal

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

connect

public ListenableFuture<WebSocketSession> connect(TransportRequest request,
                                                  WebSocketHandler handler)

Description copied from interface: Transport

Connect the transport.

Specified by:

connect in interface Transport

Parameters:

request - the transport request.

handler - the application handler to delegate lifecycle events to.

Returns:

a future to indicate success or failure to connect.

connectInternal

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object