Class ServerWebSocketContainer

java.lang.Object

org.springframework.integration.websocket.IntegrationWebSocketContainer

org.springframework.integration.websocket.ServerWebSocketContainer

All Implemented Interfaces:

DisposableBean, Lifecycle, Phased, SmartLifecycle, WebSocketConfigurer

public class ServerWebSocketContainer
extends IntegrationWebSocketContainer
implements WebSocketConfigurer, SmartLifecycle

The IntegrationWebSocketContainer implementation for the server WebSocketHandler registration.

Registers an internal IntegrationWebSocketContainer.IntegrationWebSocketHandler for provided paths with the WebSocketHandlerRegistry.

The real registration is based on Spring Web-Socket infrastructure via WebSocketConfigurer implementation of this class.

Since:

4.1

Author:

Artem Bilan, Gary Russell, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerWebSocketContainer.SockJsServiceOptions

Field Summary

Fields inherited from class org.springframework.integration.websocket.IntegrationWebSocketContainer

DEFAULT_SEND_BUFFER_SIZE, DEFAULT_SEND_TIME_LIMIT, lock, logger, sessions

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ServerWebSocketContainer(String... paths)

Method Summary

Modifier and Type	Method	Description
int	getPhase()
TaskScheduler	getSockJsTaskScheduler()
boolean	isAutoStartup()
boolean	isRunning()
void	registerWebSocketHandlers(WebSocketHandlerRegistry registry)
ServerWebSocketContainer	setAllowedOrigins(String... origins)	Configure allowed Origin header values.
void	setAutoStartup(boolean autoStartup)
ServerWebSocketContainer	setDecoratorFactories(WebSocketHandlerDecoratorFactory... factories)	Configure one or more factories to decorate the handler used to process WebSocket messages.
ServerWebSocketContainer	setHandshakeHandler(HandshakeHandler handshakeHandler)
ServerWebSocketContainer	setInterceptors(HandshakeInterceptor... interceptors)
void	setPhase(int phase)
void	setSockJsServiceOptions(ServerWebSocketContainer.SockJsServiceOptions sockJsServiceOptions)
void	setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)	Configure a TaskScheduler for SockJS fallback service.
void	start()
void	stop()
void	stop(Runnable callback)
ServerWebSocketContainer	withSockJs(ServerWebSocketContainer.SockJsServiceOptions... sockJsServiceOptions)

Methods inherited from class org.springframework.integration.websocket.IntegrationWebSocketContainer

addSupportedProtocols, closeSession, destroy, getSession, getSessions, getSubProtocols, getWebSocketHandler, setMessageListener, setSendBufferOverflowStrategy, setSendBufferSizeLimit, setSendTimeLimit, setSupportedProtocols, setWebSocketHandler

Methods inherited from class java.lang.Object

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

Constructor Details

ServerWebSocketContainer

public ServerWebSocketContainer(String... paths)

Method Details

setHandshakeHandler

public ServerWebSocketContainer setHandshakeHandler(HandshakeHandler handshakeHandler)

setInterceptors

public ServerWebSocketContainer setInterceptors(HandshakeInterceptor... interceptors)

setDecoratorFactories

public ServerWebSocketContainer setDecoratorFactories(WebSocketHandlerDecoratorFactory... factories)

Configure one or more factories to decorate the handler used to process WebSocket messages. This may be useful in some advanced use cases, for example to allow Spring Security to forcibly close the WebSocket session when the corresponding HTTP session expires.

Parameters:

factories - the WebSocketHandlerDecoratorFactory array to use

Returns:

the current ServerWebSocketContainer

Since:

4.2

setAllowedOrigins

public ServerWebSocketContainer setAllowedOrigins(String... origins)

Configure allowed Origin header values.

Parameters:

origins - the origins to allow.

Returns:

the current ServerWebSocketContainer

Since:

4.3

See Also:

• WebSocketHandlerRegistration.setAllowedOrigins(String...)

withSockJs

public ServerWebSocketContainer withSockJs(ServerWebSocketContainer.SockJsServiceOptions... sockJsServiceOptions)

setSockJsServiceOptions

public void setSockJsServiceOptions(ServerWebSocketContainer.SockJsServiceOptions sockJsServiceOptions)

setSockJsTaskScheduler

public void setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)

Configure a TaskScheduler for SockJS fallback service. This is an alternative for default SockJS service scheduler when Websocket endpoint (this server container) is registered at runtime.

Parameters:

sockJsTaskScheduler - the TaskScheduler for SockJS fallback service.

Since:

5.5.1

getSockJsTaskScheduler

public TaskScheduler getSockJsTaskScheduler()

registerWebSocketHandlers

public void registerWebSocketHandlers(WebSocketHandlerRegistry registry)

Specified by:

registerWebSocketHandlers in interface WebSocketConfigurer

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setPhase

public void setPhase(int phase)

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle