Package org.springframework.web.reactive.socket.server.upgrade

Class StandardWebSocketUpgradeStrategy

java.lang.Object

org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy

All Implemented Interfaces:

RequestUpgradeStrategy

Direct Known Subclasses:

TomcatRequestUpgradeStrategy

public class StandardWebSocketUpgradeStrategy
extends Object
implements RequestUpgradeStrategy

A WebSocket RequestUpgradeStrategy for the Jakarta WebSocket API 2.1+.

This strategy serves as a fallback if no specific server has been detected. It can also be used with Jakarta EE 10 level servers such as Tomcat 10.1 and Undertow 2.3 directly, relying on their built-in Jakarta WebSocket 2.1 support.

Since:

6.0

Author:

Juergen Hoeller, Violeta Georgieva, Rossen Stoyanchev

See Also:

• ServerContainer.upgradeHttpToWebSocket(java.lang.Object, java.lang.Object, jakarta.websocket.server.ServerEndpointConfig, java.util.Map<java.lang.String, java.lang.String>)

Constructor Summary

Constructors

Constructor	Description
StandardWebSocketUpgradeStrategy()

Method Summary

Modifier and Type	Method	Description
Long	getAsyncSendTimeout()
protected ServerContainer	getContainer(HttpServletRequest request)
Integer	getMaxBinaryMessageBufferSize()
Long	getMaxSessionIdleTimeout()
Integer	getMaxTextMessageBufferSize()
void	setAsyncSendTimeout(Long timeoutInMillis)	Exposes the underlying config option on WebSocketContainer.setAsyncSendTimeout(long).
void	setMaxBinaryMessageBufferSize(Integer bufferSize)	Exposes the underlying config option on WebSocketContainer.setDefaultMaxBinaryMessageBufferSize(int).
void	setMaxSessionIdleTimeout(Long timeoutInMillis)	Exposes the underlying config option on WebSocketContainer.setDefaultMaxSessionIdleTimeout(long).
void	setMaxTextMessageBufferSize(Integer bufferSize)	Exposes the underlying config option on WebSocketContainer.setDefaultMaxTextMessageBufferSize(int).
reactor.core.publisher.Mono<Void>	upgrade(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)	Upgrade to a WebSocket session and handle it with the given handler.
protected void	upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response, ServerEndpointConfig endpointConfig, Map<String,String> pathParams)

Methods inherited from class java.lang.Object

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

Constructor Details

StandardWebSocketUpgradeStrategy

public StandardWebSocketUpgradeStrategy()

Method Details

setAsyncSendTimeout

public void setAsyncSendTimeout(Long timeoutInMillis)

Exposes the underlying config option on WebSocketContainer.setAsyncSendTimeout(long).

getAsyncSendTimeout

@Nullable
public Long getAsyncSendTimeout()

setMaxSessionIdleTimeout

public void setMaxSessionIdleTimeout(Long timeoutInMillis)

Exposes the underlying config option on WebSocketContainer.setDefaultMaxSessionIdleTimeout(long).

getMaxSessionIdleTimeout

@Nullable
public Long getMaxSessionIdleTimeout()

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(Integer bufferSize)

Exposes the underlying config option on WebSocketContainer.setDefaultMaxTextMessageBufferSize(int).

getMaxTextMessageBufferSize

@Nullable
public Integer getMaxTextMessageBufferSize()

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(Integer bufferSize)

Exposes the underlying config option on WebSocketContainer.setDefaultMaxBinaryMessageBufferSize(int).

getMaxBinaryMessageBufferSize

@Nullable
public Integer getMaxBinaryMessageBufferSize()

upgrade

public reactor.core.publisher.Mono<Void> upgrade(ServerWebExchange exchange,
 WebSocketHandler handler,
 @Nullable
 String subProtocol,
 Supplier<HandshakeInfo> handshakeInfoFactory)

Description copied from interface: RequestUpgradeStrategy

Upgrade to a WebSocket session and handle it with the given handler.

Specified by:

upgrade in interface RequestUpgradeStrategy

Parameters:

exchange - the current exchange

handler - handler for the WebSocket session

subProtocol - the selected sub-protocol got the handler

handshakeInfoFactory - factory to create HandshakeInfo for the WebSocket session

Returns:

completion Mono<Void> to indicate the outcome of the WebSocket session handling.

upgradeHttpToWebSocket

protected void upgradeHttpToWebSocket(HttpServletRequest request,
 HttpServletResponse response,
 ServerEndpointConfig endpointConfig,
 Map<String,String> pathParams)
                               throws Exception

Throws:

Exception

getContainer

protected ServerContainer getContainer(HttpServletRequest request)