Spring Framework 6.1.4 · org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy

Modifier and Type	Field and Description
private Boolean	handlePing
private Integer	maxFramePayloadLength
private final Supplier<WebsocketServerSpec.Builder>	specBuilderSupplier

Access	Constructor and Description
public	ReactorNettyRequestUpgradeStrategy() Create an instances with a default `reactor.netty.http.server.WebsocketServerSpec.Builder`.
public	ReactorNettyRequestUpgradeStrategy(Supplier<WebsocketServerSpec.Builder> builderSupplier) Create an instance with a pre-configured `reactor.netty.http.server.WebsocketServerSpec.Builder` to use for WebSocket upgrades.

Method Summary

Modifier and Type	Method and Description
pack-priv WebsocketServerSpec	buildSpec(String subProtocol)
public boolean	getHandlePing() Deprecated as of 5.2.6 in favor of `getWebsocketServerSpec()` Return the configured `setHandlePing(boolean)`.
public int	getMaxFramePayloadLength() Deprecated as of 5.2.6 in favor of `getWebsocketServerSpec()` Return the configured max length for frames.
public WebsocketServerSpec	getWebsocketServerSpec() Build an instance of `WebsocketServerSpec` that reflects the current configuration.
public void	setHandlePing(boolean whether to let Ping frames through for handling handlePing) Deprecated as of 5.2.6 in favor of providing a supplier of `reactor.netty.http.server.WebsocketServerSpec.Builder` with a constructor argument Configure whether to let ping frames through to be handled by the `WebSocketHandler` given to the upgrade method.
public void	setMaxFramePayloadLength(Integer the max length for frames. maxFramePayloadLength) Deprecated as of 5.2.6 in favor of providing a supplier of `reactor.netty.http.server.WebsocketServerSpec.Builder` with a constructor argument Configure the maximum allowable frame payload length.
public Mono<Void>	upgrade(ServerWebExchange the current exchange exchange, WebSocketHandler handler for the WebSocket session handler, String the selected sub-protocol got the handler subProtocol, Supplier<HandshakeInfo> factory to create HandshakeInfo for the WebSocket session handshakeInfoFactory) Implements org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.upgrade. Upgrade to a WebSocket session and handle it with the given handler.

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

handlePing	back to summary
private Boolean handlePing Annotations @Nullable

maxFramePayloadLength	back to summary
private Integer maxFramePayloadLength Annotations @Nullable

specBuilderSupplier	back to summary
private final Supplier<WebsocketServerSpec.Builder> specBuilderSupplier

ReactorNettyRequestUpgradeStrategy	back to summary
public ReactorNettyRequestUpgradeStrategy() Create an instances with a default `reactor.netty.http.server.WebsocketServerSpec.Builder`. Since 5.2.6

ReactorNettyRequestUpgradeStrategy	back to summary
public ReactorNettyRequestUpgradeStrategy(Supplier<WebsocketServerSpec.Builder> builderSupplier) Create an instance with a pre-configured `reactor.netty.http.server.WebsocketServerSpec.Builder` to use for WebSocket upgrades. Since 5.2.6

Method Detail

buildSpec	back to summary
pack-priv WebsocketServerSpec buildSpec(String subProtocol)

getHandlePing back to summary

getHandlePing	back to summary
public boolean getHandlePing() Deprecated as of 5.2.6 in favor of `getWebsocketServerSpec()` Return the configured `setHandlePing(boolean)`. Annotations @Deprecated Since 5.2.4

public boolean getHandlePing()

Deprecated

as of 5.2.6 in favor of getWebsocketServerSpec()

Return the configured setHandlePing(boolean).

Annotations

@Deprecated

Since

5.2.4

getMaxFramePayloadLength back to summary

getMaxFramePayloadLength	back to summary
public int getMaxFramePayloadLength() Deprecated as of 5.2.6 in favor of `getWebsocketServerSpec()` Return the configured max length for frames. Annotations @Deprecated Since 5.1

public int getMaxFramePayloadLength()

Deprecated

as of 5.2.6 in favor of getWebsocketServerSpec()

Return the configured max length for frames.

Annotations

@Deprecated

Since

5.1

getWebsocketServerSpec back to summary

getWebsocketServerSpec	back to summary
public WebsocketServerSpec getWebsocketServerSpec() Build an instance of `WebsocketServerSpec` that reflects the current configuration. This can be used to check the configured parameters except for sub-protocols which depend on the `WebSocketHandler` that is used for a given upgrade. Since 5.2.6

public WebsocketServerSpec getWebsocketServerSpec()

Build an instance of WebsocketServerSpec that reflects the current configuration. This can be used to check the configured parameters except for sub-protocols which depend on the WebSocketHandler that is used for a given upgrade.

Since: 5.2.6

setHandlePing back to summary

setHandlePing	back to summary
public void setHandlePing(boolean handlePing) Deprecated as of 5.2.6 in favor of providing a supplier of `reactor.netty.http.server.WebsocketServerSpec.Builder` with a constructor argument Configure whether to let ping frames through to be handled by the `WebSocketHandler` given to the upgrade method. By default, Reactor Netty automatically replies with pong frames in response to pings. This is useful in a proxy for allowing ping and pong frames through. By default this is set to `false` in which case ping frames are handled automatically by Reactor Netty. If set to `true`, ping frames will be passed through to the `WebSocketHandler`. Parameters handlePing:boolean whether to let Ping frames through for handling Annotations @Deprecated Since 5.2.4

public void setHandlePing(boolean handlePing)

Deprecated

as of 5.2.6 in favor of providing a supplier of reactor.netty.http.server.WebsocketServerSpec.Builder with a constructor argument

Configure whether to let ping frames through to be handled by the WebSocketHandler given to the upgrade method. By default, Reactor Netty automatically replies with pong frames in response to pings. This is useful in a proxy for allowing ping and pong frames through.

By default this is set to false in which case ping frames are handled automatically by Reactor Netty. If set to true, ping frames will be passed through to the WebSocketHandler.

Parameters

handlePing:boolean: whether to let Ping frames through for handling

Annotations

@Deprecated

Since

5.2.4

setMaxFramePayloadLength back to summary

setMaxFramePayloadLength	back to summary
public void setMaxFramePayloadLength(Integer maxFramePayloadLength) Deprecated as of 5.2.6 in favor of providing a supplier of `reactor.netty.http.server.WebsocketServerSpec.Builder` with a constructor argument Configure the maximum allowable frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames. Corresponds to the argument with the same name in the constructor of `WebSocketServerHandshakerFactory` in Netty. By default set to 65536 (64K). Parameters maxFramePayloadLength:Integer the max length for frames. Annotations @Deprecated Since 5.1

public void setMaxFramePayloadLength(Integer maxFramePayloadLength)

Deprecated

as of 5.2.6 in favor of providing a supplier of reactor.netty.http.server.WebsocketServerSpec.Builder with a constructor argument

Configure the maximum allowable frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames.

Corresponds to the argument with the same name in the constructor of WebSocketServerHandshakerFactory in Netty.

By default set to 65536 (64K).

Parameters

maxFramePayloadLength:Integer: the max length for frames.

Annotations

@Deprecated

Since

5.1

upgrade back to summary

upgrade	back to summary
public Mono<Void> upgrade(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory) Implements org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.upgrade. Doc from org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.upgrade. Upgrade to a WebSocket session and handle it with the given handler. Parameters exchange:ServerWebExchange the current exchange handler:WebSocketHandler handler for the WebSocket session subProtocol:String the selected sub-protocol got the handler handshakeInfoFactory:Supplier<HandshakeInfo> factory to create HandshakeInfo for the WebSocket session Returns:Mono<Void> completion `Mono<Void>` to indicate the outcome of the WebSocket session handling. Annotations @Override

public Mono<Void> upgrade(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)

Implements org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.upgrade.

Doc from org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.upgrade.

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

Parameters

exchange:ServerWebExchange: the current exchange
handler:WebSocketHandler: handler for the WebSocket session
subProtocol:String: the selected sub-protocol got the handler
handshakeInfoFactory:Supplier<HandshakeInfo>: factory to create HandshakeInfo for the WebSocket session

Returns:Mono<Void>

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

Annotations

@Override

public Class ReactorNettyRequestUpgradeStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail