Modifier and Type	Class and Description
private class	DefaultTransportRequest.CompletableConnectCallback Updates the given (global) future based success or failure to connect for the entire SockJS request regardless of which transport actually managed to connect.
private class	DefaultTransportRequest.ListenableConnectCallback References Deprecated `ListenableFutureCallback` is deprecated or references (maybe indirectly) at least one deprecated element. Updates the given (global) future based success or failure to connect for the entire SockJS request regardless of which transport actually managed to connect.

Modifier and Type	Field and Description
private final SockJsMessageCodec	codec
private DefaultTransportRequest	fallbackRequest
private final HttpHeaders	handshakeHeaders
private final HttpHeaders	httpRequestHeaders
private static final Log	logger
private final TransportType	serverTransportType
private final SockJsUrlInfo	sockJsUrlInfo
private TaskScheduler	timeoutScheduler
private final List<Runnable>	timeoutTasks
private long	timeoutValue
private final Transport	transport
private Principal	user

Access	Constructor and Description
public	DefaultTransportRequest(SockJsUrlInfo sockJsUrlInfo, HttpHeaders handshakeHeaders, HttpHeaders httpRequestHeaders, Transport transport, TransportType serverTransportType, SockJsMessageCodec codec)

Method Summary

Modifier and Type	Method and Description
public void	addTimeoutTask(Runnable runnable) Implements org.springframework.web.socket.sockjs.client.TransportRequest.addTimeoutTask. Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.
public void	connect(WebSocketHandler handler, SettableListenableFuture<WebSocketSession> future) Deprecated
public void	connect(WebSocketHandler handler, CompletableFuture<WebSocketSession> future)
public HttpHeaders	getHandshakeHeaders() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getHandshakeHeaders. Return the headers to send with the connect request.
public HttpHeaders	getHttpRequestHeaders() Implements org.springframework.web.socket.sockjs.client.TransportRequest.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() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getMessageCodec. Return the message codec to use for encoding SockJS messages.
public SockJsUrlInfo	getSockJsUrlInfo() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getSockJsUrlInfo. Return information about the SockJS URL including server and session ID.
public URI	getTransportUrl() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getTransportUrl. Return the transport URL for the given transport.
public Principal	getUser() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getUser. Return the user associated with the request, if any.
private void	scheduleConnectTimeoutTask(DefaultTransportRequest.ListenableConnectCallback connectHandler) References Deprecated `DefaultTransportRequest.ListenableConnectCallback` is deprecated or references (maybe indirectly) at least one deprecated element.
private void	scheduleConnectTimeoutTask(DefaultTransportRequest.CompletableConnectCallback connectHandler)
public void	setFallbackRequest(DefaultTransportRequest fallbackRequest)
public void	setTimeoutScheduler(TaskScheduler scheduler)
public void	setTimeoutValue(long timeoutValue)
public void	setUser(Principal user)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

codec	back to summary
private final SockJsMessageCodec codec

fallbackRequest	back to summary
private DefaultTransportRequest fallbackRequest Annotations @Nullable

handshakeHeaders	back to summary
private final HttpHeaders handshakeHeaders

httpRequestHeaders	back to summary
private final HttpHeaders httpRequestHeaders

logger	back to summary
private static final Log logger

serverTransportType	back to summary
private final TransportType serverTransportType

sockJsUrlInfo	back to summary
private final SockJsUrlInfo sockJsUrlInfo

timeoutScheduler	back to summary
private TaskScheduler timeoutScheduler Annotations @Nullable

timeoutTasks	back to summary
private final List<Runnable> timeoutTasks

timeoutValue	back to summary
private long timeoutValue

transport	back to summary
private final Transport transport

user	back to summary
private Principal user Annotations @Nullable

DefaultTransportRequest	back to summary
public DefaultTransportRequest(SockJsUrlInfo sockJsUrlInfo, HttpHeaders handshakeHeaders, HttpHeaders httpRequestHeaders, Transport transport, TransportType serverTransportType, SockJsMessageCodec codec)

Method Detail

addTimeoutTask	back to summary
public void addTimeoutTask(Runnable runnable) Implements org.springframework.web.socket.sockjs.client.TransportRequest.addTimeoutTask. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.addTimeoutTask. Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period. Annotations @Override

addTimeoutTask

back to summary

public void addTimeoutTask(Runnable runnable)

Implements org.springframework.web.socket.sockjs.client.TransportRequest.addTimeoutTask.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.addTimeoutTask.

Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.

Annotations

@Override

connect	back to summary
public void connect(WebSocketHandler handler, SettableListenableFuture<WebSocketSession> future) Deprecated Annotations @Deprecated

connect	back to summary
public void connect(WebSocketHandler handler, CompletableFuture<WebSocketSession> future)

getHandshakeHeaders	back to summary
public HttpHeaders getHandshakeHeaders() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getHandshakeHeaders. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getHandshakeHeaders. Return the headers to send with the connect request. Annotations @Override

getHandshakeHeaders

back to summary

public HttpHeaders getHandshakeHeaders()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getHandshakeHeaders.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getHandshakeHeaders.

Return the headers to send with the connect request.

Annotations

@Override

getHttpRequestHeaders	back to summary
public HttpHeaders getHttpRequestHeaders() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getHttpRequestHeaders. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getHttpRequestHeaders. Return the headers to add to all other HTTP requests besides the handshake request such as XHR receive and send requests. Annotations @Override

getHttpRequestHeaders

back to summary

public HttpHeaders getHttpRequestHeaders()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getHttpRequestHeaders.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getHttpRequestHeaders.

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

Annotations

@Override

getMessageCodec	back to summary
public SockJsMessageCodec getMessageCodec() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getMessageCodec. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getMessageCodec. Return the message codec to use for encoding SockJS messages. Annotations @Override

getMessageCodec

back to summary

public SockJsMessageCodec getMessageCodec()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getMessageCodec.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getMessageCodec.

Return the message codec to use for encoding SockJS messages.

Annotations

@Override

getSockJsUrlInfo	back to summary
public SockJsUrlInfo getSockJsUrlInfo() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getSockJsUrlInfo. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getSockJsUrlInfo. Return information about the SockJS URL including server and session ID. Annotations @Override

getSockJsUrlInfo

back to summary

public SockJsUrlInfo getSockJsUrlInfo()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getSockJsUrlInfo.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getSockJsUrlInfo.

Return information about the SockJS URL including server and session ID.

Annotations

@Override

getTransportUrl back to summary

getTransportUrl	back to summary
public URI getTransportUrl() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getTransportUrl. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getTransportUrl. Return the transport URL for the given transport. For an `XhrTransport` this is the URL for receiving messages. Annotations @Override

public URI getTransportUrl()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getTransportUrl.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getTransportUrl.

Return the transport URL for the given transport.

For an XhrTransport this is the URL for receiving messages.

Annotations

@Override

getUser	back to summary
public Principal getUser() Implements org.springframework.web.socket.sockjs.client.TransportRequest.getUser. Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getUser. Return the user associated with the request, if any. Annotations @Override @Nullable

getUser

back to summary

public Principal getUser()

Implements org.springframework.web.socket.sockjs.client.TransportRequest.getUser.

Doc from org.springframework.web.socket.sockjs.client.TransportRequest.getUser.

Return the user associated with the request, if any.

Annotations

@Override
@Nullable

scheduleConnectTimeoutTask	back to summary
private void scheduleConnectTimeoutTask(DefaultTransportRequest.ListenableConnectCallback connectHandler) References Deprecated `DefaultTransportRequest.ListenableConnectCallback` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

scheduleConnectTimeoutTask	back to summary
private void scheduleConnectTimeoutTask(DefaultTransportRequest.CompletableConnectCallback connectHandler)

setFallbackRequest	back to summary
public void setFallbackRequest(DefaultTransportRequest fallbackRequest)

setTimeoutScheduler	back to summary
public void setTimeoutScheduler(TaskScheduler scheduler)

setTimeoutValue	back to summary
public void setTimeoutValue(long timeoutValue)

setUser	back to summary
public void setUser(Principal user)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

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

private Class DefaultTransportRequest.CompletableConnectCallback

Class Inheritance

extends Object
implements Runnable, BiConsumer<WebSocketSession, Throwable>

java.lang.Object
org.springframework.web.socket.sockjs.client.DefaultTransportRequest.CompletableConnectCallback

All Implemented Interfaces

java.util.function.BiConsumer, java.lang.Runnable

Updates the given (global) future based success or failure to connect for the entire SockJS request regardless of which transport actually managed to connect. Also implements Runnable to handle a scheduled timeout callback.

Field Summary

Modifier and Type	Field and Description
private final CompletableFuture<WebSocketSession>	future
private final AtomicBoolean	handled
private final WebSocketHandler	handler

Constructor Summary

Access	Constructor and Description
public	CompletableConnectCallback(WebSocketHandler handler, CompletableFuture<WebSocketSession> future)

Method Summary

Modifier and Type	Method and Description
public void	accept(WebSocketSession the first input argument session, Throwable the second input argument throwable) Implements java.util.function.BiConsumer.accept. Performs this operation on the given arguments.
private void	handleFailure(Throwable ex, boolean isTimeoutFailure)
public void	run() Implements java.lang.Runnable.run. Runs this operation.

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

Field Detail

future	back to summary
private final CompletableFuture<WebSocketSession> future

handled	back to summary
private final AtomicBoolean handled

handler	back to summary
private final WebSocketHandler handler

Constructor Detail

CompletableConnectCallback	back to summary
public CompletableConnectCallback(WebSocketHandler handler, CompletableFuture<WebSocketSession> future)

Method Detail

accept	back to summary
public void accept(WebSocketSession session, Throwable throwable) Implements java.util.function.BiConsumer.accept. Doc from java.util.function.BiConsumer.accept. Performs this operation on the given arguments. Parameters session:WebSocketSession the first input argument throwable:Throwable the second input argument Annotations @Override

back to summary

public void accept(WebSocketSession session, Throwable throwable)

Implements java.util.function.BiConsumer.accept.

Doc from java.util.function.BiConsumer.accept.

Performs this operation on the given arguments.

Parameters

session:WebSocketSession: the first input argument
throwable:Throwable: the second input argument

Annotations

@Override

handleFailure	back to summary
private void handleFailure(Throwable ex, boolean isTimeoutFailure)

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

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

private Class DefaultTransportRequest.ListenableConnectCallback

Class Inheritance

extends Object
implements ListenableFutureCallback<WebSocketSession>, Runnable

java.lang.Object
org.springframework.web.socket.sockjs.client.DefaultTransportRequest.ListenableConnectCallback

All Implemented Interfaces

java.lang.Runnable, org.springframework.util.concurrent.ListenableFutureCallback, org.springframework.util.concurrent.FailureCallback, org.springframework.util.concurrent.SuccessCallback

Annotations

@SuppressWarnings:deprecation

References Deprecated

ListenableFutureCallback is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Field Summary

Modifier and Type	Field and Description
private final SettableListenableFuture<WebSocketSession>	future References Deprecated `SettableListenableFuture` is deprecated or references (maybe indirectly) at least one deprecated element.
private final AtomicBoolean	handled
private final WebSocketHandler	handler

Constructor Summary

Access	Constructor and Description
public	ListenableConnectCallback(WebSocketHandler handler, SettableListenableFuture<WebSocketSession> future) References Deprecated `SettableListenableFuture` is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and Type	Method and Description
private void	handleFailure(Throwable ex, boolean isTimeoutFailure)
public void	onFailure(Throwable the failure ex) Implements org.springframework.util.concurrent.FailureCallback.onFailure. Called when the `ListenableFuture` completes with failure.
public void	onSuccess(WebSocketSession the result session) Implements org.springframework.util.concurrent.SuccessCallback.onSuccess. Called when the `ListenableFuture` completes with success.
public void	run() Implements java.lang.Runnable.run. Runs this operation.

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

Field Detail

future	back to summary
private final SettableListenableFuture<WebSocketSession> future References Deprecated `SettableListenableFuture` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

handled	back to summary
private final AtomicBoolean handled

handler	back to summary
private final WebSocketHandler handler

Constructor Detail

ListenableConnectCallback	back to summary
public ListenableConnectCallback(WebSocketHandler handler, SettableListenableFuture<WebSocketSession> future) References Deprecated `SettableListenableFuture` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

Method Detail

handleFailure	back to summary
private void handleFailure(Throwable ex, boolean isTimeoutFailure)

onFailure back to summary

public void onFailure(Throwable ex)

Implements org.springframework.util.concurrent.FailureCallback.onFailure.

Doc from org.springframework.util.concurrent.FailureCallback.onFailure.

Called when the ListenableFuture completes with failure.

Note that Exceptions raised by this method are ignored.

Parameters

ex:Throwable: the failure

Annotations

@Override

onSuccess back to summary

public void onSuccess(WebSocketSession session)

Implements org.springframework.util.concurrent.SuccessCallback.onSuccess.

Doc from org.springframework.util.concurrent.SuccessCallback.onSuccess.

Called when the ListenableFuture completes with success.

Note that Exceptions raised by this method are ignored.

Parameters

session:WebSocketSession: the result

Annotations

@Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

pack-priv Class DefaultTransportRequest

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultTransportRequest.CompletableConnectCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultTransportRequest.ListenableConnectCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail