Spring Framework 6.1.4 · org.springframework.web.socket.sockjs.client.TransportRequest

Exposes information, typically to Transport and session implementations, about a request to connect to a SockJS server endpoint over a given transport.

Note that a single request to connect via SockJsClient may result in multiple instances of TransportRequest, one for each transport before a connection is successfully established.

Method Summary

Modifier and Type	Method and Description
public void	addTimeoutTask(Runnable runnable) Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.
public HttpHeaders	getHandshakeHeaders() Return the headers to send with the connect request.
public HttpHeaders	getHttpRequestHeaders() Return the headers to add to all other HTTP requests besides the handshake request such as XHR receive and send requests.
public SockJsMessageCodec	getMessageCodec() Return the message codec to use for encoding SockJS messages.
public SockJsUrlInfo	getSockJsUrlInfo() Return information about the SockJS URL including server and session ID.
public URI	getTransportUrl() Return the transport URL for the given transport.
public Principal	getUser() Return the user associated with the request, if any.

Method Detail

addTimeoutTask	back to summary
public void addTimeoutTask(Runnable runnable) Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.

getHandshakeHeaders	back to summary
public HttpHeaders getHandshakeHeaders() Return the headers to send with the connect request.

getHttpRequestHeaders	back to summary
public HttpHeaders getHttpRequestHeaders() Return the headers to add to all other HTTP requests besides the handshake request such as XHR receive and send requests. Since 4.2

getHttpRequestHeaders

back to summary

public HttpHeaders getHttpRequestHeaders()

Return the headers to add to all other HTTP requests besides the handshake request such as XHR receive and send requests.

Since: 4.2

getMessageCodec	back to summary
public SockJsMessageCodec getMessageCodec() Return the message codec to use for encoding SockJS messages.

getSockJsUrlInfo	back to summary
public SockJsUrlInfo getSockJsUrlInfo() Return information about the SockJS URL including server and session ID.

getTransportUrl back to summary

getTransportUrl	back to summary
public URI getTransportUrl() Return the transport URL for the given transport. For an `XhrTransport` this is the URL for receiving messages.

public URI getTransportUrl()

Return the transport URL for the given transport.

For an XhrTransport this is the URL for receiving messages.

getUser	back to summary
public Principal getUser() Return the user associated with the request, if any. Annotations @Nullable

getUser

back to summary

public Principal getUser()

Return the user associated with the request, if any.

Annotations

@Nullable

public Interface TransportRequest

Method Summary

Method Detail