Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SockJsClient.ServerInfo A simple value object holding the result from a SockJS "Info" request.

Field Summary

Modifier and Type	Field and Description
private TaskScheduler	connectTimeoutScheduler
private String[]	httpHeaderNames
private InfoReceiver	infoReceiver
private static final boolean	jackson2Present
private static final Log	logger
private SockJsMessageCodec	messageCodec
private volatile boolean	running
private final Map<URI, SockJsClient.ServerInfo>	serverInfoCache
private static final Set<String>	supportedProtocols
private final List<Transport>	transports

Constructor Summary

Access	Constructor and Description
public	SockJsClient(List<Transport> the (non-empty) list of transports to use transports) Create a `SockJsClient` with the given transports.

Method Summary

Modifier and Type	Method and Description
protected SockJsUrlInfo	buildSockJsUrlInfo(URI the target URL url) Create a new `SockJsUrlInfo` for the current client execution.
public void	clearServerInfoCache() By default, the result of a SockJS "Info" request, including whether the server has WebSocket disabled and how long the request took (used for calculating transport timeout time) is cached.
private DefaultTransportRequest	createRequest(SockJsUrlInfo urlInfo, HttpHeaders headers, SockJsClient.ServerInfo serverInfo)
public CompletableFuture<WebSocketSession>	execute(WebSocketHandler the session handler handler, String the url template uriTemplate, Object... the variables to expand the template uriVars) Implements org.springframework.web.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
public final CompletableFuture<WebSocketSession>	execute(WebSocketHandler the session handler handler, WebSocketHttpHeaders headers, URI the url url) Implements org.springframework.web.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
public String[]	getHttpHeaderNames() The configured HTTP header names to be copied from the handshake headers and also included in other HTTP requests.
private HttpHeaders	getHttpRequestHeaders(HttpHeaders webSocketHttpHeaders)
public InfoReceiver	getInfoReceiver() Return the configured `InfoReceiver` (never `null`).
public SockJsMessageCodec	getMessageCodec() Return the SockJsMessageCodec to use.
private SockJsClient.ServerInfo	getServerInfo(SockJsUrlInfo sockJsUrlInfo, HttpHeaders headers)
protected Principal	Returns: the user to associate with the session (possibly `null`) getUser() Return the user to associate with the SockJS session and make available via `org.springframework.web.socket.WebSocketSession#getPrincipal()`.
private static InfoReceiver	initInfoReceiver(List<Transport> transports)
public boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running.
public void	setConnectTimeoutScheduler(TaskScheduler the task scheduler to use connectTimeoutScheduler) Configure a `TaskScheduler` for scheduling a connect timeout task where the timeout value is calculated based on the duration of the initial SockJS "Info" request.
public void	setHttpHeaderNames(String... the HTTP header names httpHeaderNames) The names of HTTP headers that should be copied from the handshake headers of each call to `SockJsClient#doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI)` and also used with other HTTP requests issued as part of that SockJS connection, e.g. the initial info request, XHR send or receive requests.
public void	setInfoReceiver(InfoReceiver the transport to use for the SockJS "Info" request infoReceiver) Configure the `InfoReceiver` to use to perform the SockJS "Info" request before the SockJS session starts.
public void	setMessageCodec(SockJsMessageCodec messageCodec) Set the SockJsMessageCodec to use.
public void	start() Implements org.springframework.context.Lifecycle.start. Start this component.
public void	stop() Implements org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.

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

Field Detail

connectTimeoutScheduler	back to summary
private TaskScheduler connectTimeoutScheduler Annotations @Nullable

httpHeaderNames	back to summary
private String[] httpHeaderNames Annotations @Nullable

infoReceiver	back to summary
private InfoReceiver infoReceiver

jackson2Present	back to summary
private static final boolean jackson2Present

logger	back to summary
private static final Log logger

messageCodec	back to summary
private SockJsMessageCodec messageCodec Annotations @Nullable

running	back to summary
private volatile boolean running

serverInfoCache	back to summary
private final Map<URI, SockJsClient.ServerInfo> serverInfoCache

supportedProtocols	back to summary
private static final Set<String> supportedProtocols

transports	back to summary
private final List<Transport> transports

Constructor Detail

SockJsClient back to summary

SockJsClient	back to summary
public SockJsClient(List<Transport> transports) Create a `SockJsClient` with the given transports. If the list includes an `XhrTransport` (or more specifically an implementation of `InfoReceiver`) the instance is used to initialize the `infoReceiver` property, or otherwise is defaulted to `RestTemplateXhrTransport`. Parameters transports:List<Transport> the (non-empty) list of transports to use

public SockJsClient(List<Transport> transports)

Create a SockJsClient with the given transports.

If the list includes an XhrTransport (or more specifically an implementation of InfoReceiver) the instance is used to initialize the infoReceiver property, or otherwise is defaulted to RestTemplateXhrTransport.

Parameters

transports:List<Transport>: the (non-empty) list of transports to use

Method Detail

buildSockJsUrlInfo back to summary

buildSockJsUrlInfo	back to summary
protected SockJsUrlInfo buildSockJsUrlInfo(URI url) Create a new `SockJsUrlInfo` for the current client execution. The default implementation builds a `SockJsUrlInfo` which calculates a random server id and session id if necessary. Parameters url:URI the target URL Since 6.1.3 See Also `SockJsUrlInfo#SockJsUrlInfo(URI)`

protected SockJsUrlInfo buildSockJsUrlInfo(URI url)

Create a new SockJsUrlInfo for the current client execution.

The default implementation builds a SockJsUrlInfo which calculates a random server id and session id if necessary.

Parameters

url:URI: the target URL

Since

6.1.3

See Also

SockJsUrlInfo#SockJsUrlInfo(URI)

clearServerInfoCache	back to summary
public void clearServerInfoCache() By default, the result of a SockJS "Info" request, including whether the server has WebSocket disabled and how long the request took (used for calculating transport timeout time) is cached. This method can be used to clear that cache hence causing it to re-populate.

createRequest	back to summary
private DefaultTransportRequest createRequest(SockJsUrlInfo urlInfo, HttpHeaders headers, SockJsClient.ServerInfo serverInfo)

execute	back to summary
public CompletableFuture<WebSocketSession> execute(WebSocketHandler handler, String uriTemplate, Object... uriVars) Implements org.springframework.web.socket.client.WebSocketClient.execute. Doc from org.springframework.web.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler. Parameters handler:WebSocketHandler the session handler uriTemplate:String the url template uriVars:Object[] the variables to expand the template Returns:CompletableFuture<WebSocketSession> a future that completes when the session is available Annotations @Override

execute

back to summary

public CompletableFuture<WebSocketSession> execute(WebSocketHandler handler, String uriTemplate, Object... uriVars)

Implements org.springframework.web.socket.client.WebSocketClient.execute.

Doc from org.springframework.web.socket.client.WebSocketClient.execute.

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters

handler:WebSocketHandler: the session handler
uriTemplate:String: the url template
uriVars:Object[]: the variables to expand the template

Returns:CompletableFuture<WebSocketSession>

a future that completes when the session is available

Annotations

@Override

execute	back to summary
public final CompletableFuture<WebSocketSession> execute(WebSocketHandler handler, WebSocketHttpHeaders headers, URI url) Implements org.springframework.web.socket.client.WebSocketClient.execute. Doc from org.springframework.web.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler. Parameters handler:WebSocketHandler the session handler url:URI the url Returns:CompletableFuture<WebSocketSession> a future that completes when the session is available Annotations @Override

execute

back to summary

public final CompletableFuture<WebSocketSession> execute(WebSocketHandler handler, WebSocketHttpHeaders headers, URI url)

Implements org.springframework.web.socket.client.WebSocketClient.execute.

Doc from org.springframework.web.socket.client.WebSocketClient.execute.

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters

handler:WebSocketHandler: the session handler
url:URI: the url

Returns:CompletableFuture<WebSocketSession>

a future that completes when the session is available

Annotations

@Override

getHttpHeaderNames	back to summary
public String[] getHttpHeaderNames() The configured HTTP header names to be copied from the handshake headers and also included in other HTTP requests. Annotations @Nullable

getHttpHeaderNames

back to summary

public String[] getHttpHeaderNames()

The configured HTTP header names to be copied from the handshake headers and also included in other HTTP requests.

Annotations

@Nullable

getHttpRequestHeaders	back to summary
private HttpHeaders getHttpRequestHeaders(HttpHeaders webSocketHttpHeaders) Annotations @Nullable

getInfoReceiver	back to summary
public InfoReceiver getInfoReceiver() Return the configured `InfoReceiver` (never `null`).

getMessageCodec	back to summary
public SockJsMessageCodec getMessageCodec() Return the SockJsMessageCodec to use.

getServerInfo	back to summary
private SockJsClient.ServerInfo getServerInfo(SockJsUrlInfo sockJsUrlInfo, HttpHeaders headers)

getUser back to summary

getUser	back to summary
protected Principal getUser() Return the user to associate with the SockJS session and make available via `org.springframework.web.socket.WebSocketSession#getPrincipal()`. By default this method returns `null`. Returns:Principal the user to associate with the session (possibly `null`) Annotations @Nullable

protected Principal getUser()

Return the user to associate with the SockJS session and make available via org.springframework.web.socket.WebSocketSession#getPrincipal().

By default this method returns null.

Returns:Principal

the user to associate with the session (possibly null)

Annotations

@Nullable

initInfoReceiver	back to summary
private static InfoReceiver initInfoReceiver(List<Transport> transports)

isRunning back to summary

isRunning	back to summary
public boolean isRunning() Implements org.springframework.context.Lifecycle.isRunning. Doc from org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running. In the case of a container, this will return `true` only if all components that apply are currently running. Returns:boolean whether the component is currently running Annotations @Override

public boolean isRunning()

Implements org.springframework.context.Lifecycle.isRunning.

Doc from org.springframework.context.Lifecycle.isRunning.

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

Returns:boolean

whether the component is currently running

Annotations

@Override

setConnectTimeoutScheduler back to summary

setConnectTimeoutScheduler	back to summary
public void setConnectTimeoutScheduler(TaskScheduler connectTimeoutScheduler) Configure a `TaskScheduler` for scheduling a connect timeout task where the timeout value is calculated based on the duration of the initial SockJS "Info" request. The connect timeout task ensures a more timely fallback but is otherwise entirely optional. By default this is not configured in which case a fallback may take longer. Parameters connectTimeoutScheduler:TaskScheduler the task scheduler to use

public void setConnectTimeoutScheduler(TaskScheduler connectTimeoutScheduler)

Configure a TaskScheduler for scheduling a connect timeout task where the timeout value is calculated based on the duration of the initial SockJS "Info" request. The connect timeout task ensures a more timely fallback but is otherwise entirely optional.

By default this is not configured in which case a fallback may take longer.

Parameters

connectTimeoutScheduler:TaskScheduler: the task scheduler to use

setHttpHeaderNames back to summary

setHttpHeaderNames	back to summary
public void setHttpHeaderNames(String... httpHeaderNames) The names of HTTP headers that should be copied from the handshake headers of each call to `SockJsClient#doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI)` and also used with other HTTP requests issued as part of that SockJS connection, e.g. the initial info request, XHR send or receive requests. By default if this property is not set, all handshake headers are also used for other HTTP requests. Set it if you want only a subset of handshake headers (e.g. auth headers) to be used for other HTTP requests. Parameters httpHeaderNames:String[] the HTTP header names

public void setHttpHeaderNames(String... httpHeaderNames)

The names of HTTP headers that should be copied from the handshake headers of each call to SockJsClient#doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI) and also used with other HTTP requests issued as part of that SockJS connection, e.g. the initial info request, XHR send or receive requests.

By default if this property is not set, all handshake headers are also used for other HTTP requests. Set it if you want only a subset of handshake headers (e.g. auth headers) to be used for other HTTP requests.

Parameters

httpHeaderNames:String[]: the HTTP header names

setInfoReceiver back to summary

setInfoReceiver	back to summary
public void setInfoReceiver(InfoReceiver infoReceiver) Configure the `InfoReceiver` to use to perform the SockJS "Info" request before the SockJS session starts. If the list of transports provided to the constructor contained an `XhrTransport` or an implementation of `InfoReceiver` that instance would have been used to initialize this property, or otherwise it defaults to `RestTemplateXhrTransport`. Parameters infoReceiver:InfoReceiver the transport to use for the SockJS "Info" request

public void setInfoReceiver(InfoReceiver infoReceiver)

Configure the InfoReceiver to use to perform the SockJS "Info" request before the SockJS session starts.

If the list of transports provided to the constructor contained an XhrTransport or an implementation of InfoReceiver that instance would have been used to initialize this property, or otherwise it defaults to RestTemplateXhrTransport.

Parameters

infoReceiver:InfoReceiver: the transport to use for the SockJS "Info" request

setMessageCodec back to summary

setMessageCodec	back to summary
public void setMessageCodec(SockJsMessageCodec messageCodec) Set the SockJsMessageCodec to use. By default `Jackson2SockJsMessageCodec` is used if Jackson is on the classpath.

public void setMessageCodec(SockJsMessageCodec messageCodec)

Set the SockJsMessageCodec to use.

By default Jackson2SockJsMessageCodec is used if Jackson is on the classpath.

start	back to summary
public void start() Implements org.springframework.context.Lifecycle.start. Doc from org.springframework.context.Lifecycle.start. Start this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate the start signal to all components that apply. Annotations @Override

start

back to summary

public void start()

Implements org.springframework.context.Lifecycle.start.

Doc from org.springframework.context.Lifecycle.start.

Start this component.

Should not throw an exception if the component is already running.

In the case of a container, this will propagate the start signal to all components that apply.

Annotations

@Override

stop back to summary

stop	back to summary
public void stop() Implements org.springframework.context.Lifecycle.stop. Doc from org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing `SmartLifecycle` and its `stop(Runnable)` variant when asynchronous stop behavior is necessary. Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, `Lifecycle` beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront. Should not throw an exception if the component is not running (not started yet). In the case of a container, this will propagate the stop signal to all components that apply. Annotations @Override

public void stop()

Implements org.springframework.context.Lifecycle.stop.

Doc from org.springframework.context.Lifecycle.stop.

Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

Should not throw an exception if the component is not running (not started yet).

In the case of a container, this will propagate the stop signal to all components that apply.

Annotations

@Override

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

private Class SockJsClient.ServerInfo

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.socket.sockjs.client.SockJsClient.ServerInfo

A simple value object holding the result from a SockJS "Info" request.

Field Summary

Modifier and Type	Field and Description
private final long	responseTime
private final boolean	webSocketEnabled

Constructor Summary

Access	Constructor and Description
public	ServerInfo(String response, long responseTime)

Method Summary

Modifier and Type	Method and Description
public long	getRetransmissionTimeout()
public boolean	isWebSocketEnabled()

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

Field Detail

responseTime	back to summary
private final long responseTime

webSocketEnabled	back to summary
private final boolean webSocketEnabled

Constructor Detail

ServerInfo	back to summary
public ServerInfo(String response, long responseTime)

Method Detail

getRetransmissionTimeout	back to summary
public long getRetransmissionTimeout()

isWebSocketEnabled	back to summary
public boolean isWebSocketEnabled()

public Class SockJsClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SockJsClient.ServerInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail