Method Detail

setHttpHeaderNames

The names of HTTP headers that should be copied from the handshake headers
of each call to 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.

getMessageCodec

setConnectTimeoutScheduler

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.

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.

clearServerInfoCache

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.