Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HandshakeWebSocketService.ReactorNettyStrategyDelegate Inner class to avoid a reachable dependency on Reactor Netty API.

Field Summary

Modifier and Type	Field and Description
private static final Mono<Map<String, Object>>	EMPTY_ATTRIBUTES
private static final boolean	jettyWsPresent
private static final Log	logger
private static final boolean	reactorNetty2Present
private static final boolean	reactorNettyPresent
private volatile boolean	running
private static final String	SEC_WEBSOCKET_KEY
private static final String	SEC_WEBSOCKET_PROTOCOL
private Predicate<String>	sessionAttributePredicate
private static final boolean	tomcatWsPresent
private static final boolean	undertowWsPresent
private final RequestUpgradeStrategy	upgradeStrategy

Constructor Summary

Access	Constructor and Description
public	HandshakeWebSocketService() Default constructor automatic, classpath detection based discovery of the `RequestUpgradeStrategy` to use.
public	HandshakeWebSocketService(RequestUpgradeStrategy the strategy to use upgradeStrategy) Alternative constructor with the `RequestUpgradeStrategy` to use.

Method Summary

Modifier and Type	Method and Description
private HandshakeInfo	createHandshakeInfo(ServerWebExchange exchange, ServerHttpRequest request, String protocol, Map<String, Object> attributes)
protected void	doStart()
protected void	doStop()
public Predicate<String>	getSessionAttributePredicate() Return the configured predicate for initialization WebSocket session attributes from `WebSession` attributes.
public RequestUpgradeStrategy	getUpgradeStrategy() Return the `RequestUpgradeStrategy` for WebSocket requests.
private Mono<Void>	handleBadRequest(ServerWebExchange exchange, String reason)
public Mono<Void>	handleRequest(ServerWebExchange the current exchange exchange, WebSocketHandler handler for WebSocket session handler) Implements org.springframework.web.reactive.socket.server.WebSocketService.handleRequest. Handle the request with the given `WebSocketHandler`.
private Mono<Map<String, Object>>	initAttributes(ServerWebExchange exchange)
pack-priv static RequestUpgradeStrategy	initUpgradeStrategy()
public boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running.
private String	selectProtocol(HttpHeaders headers, WebSocketHandler handler)
public void	setSessionAttributePredicate(Predicate<String> the predicate predicate) Configure a predicate to use to extract `WebSession` attributes and use them to initialize the WebSocket session with.
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

EMPTY_ATTRIBUTES	back to summary
private static final Mono<Map<String, Object>> EMPTY_ATTRIBUTES

jettyWsPresent	back to summary
private static final boolean jettyWsPresent

logger	back to summary
private static final Log logger

reactorNetty2Present	back to summary
private static final boolean reactorNetty2Present

reactorNettyPresent	back to summary
private static final boolean reactorNettyPresent

running	back to summary
private volatile boolean running

SEC_WEBSOCKET_KEY	back to summary
private static final String SEC_WEBSOCKET_KEY

SEC_WEBSOCKET_PROTOCOL	back to summary
private static final String SEC_WEBSOCKET_PROTOCOL

sessionAttributePredicate	back to summary
private Predicate<String> sessionAttributePredicate Annotations @Nullable

tomcatWsPresent	back to summary
private static final boolean tomcatWsPresent

undertowWsPresent	back to summary
private static final boolean undertowWsPresent

upgradeStrategy	back to summary
private final RequestUpgradeStrategy upgradeStrategy

Constructor Detail

HandshakeWebSocketService	back to summary
public HandshakeWebSocketService() Default constructor automatic, classpath detection based discovery of the `RequestUpgradeStrategy` to use.

HandshakeWebSocketService back to summary

HandshakeWebSocketService	back to summary
public HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy) Alternative constructor with the `RequestUpgradeStrategy` to use. Parameters upgradeStrategy:RequestUpgradeStrategy the strategy to use

public HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy)

Alternative constructor with the RequestUpgradeStrategy to use.

Parameters

upgradeStrategy:RequestUpgradeStrategy: the strategy to use

Method Detail

createHandshakeInfo	back to summary
private HandshakeInfo createHandshakeInfo(ServerWebExchange exchange, ServerHttpRequest request, String protocol, Map<String, Object> attributes)

doStart	back to summary
protected void doStart()

doStop	back to summary
protected void doStop()

getSessionAttributePredicate back to summary

getSessionAttributePredicate	back to summary
public Predicate<String> getSessionAttributePredicate() Return the configured predicate for initialization WebSocket session attributes from `WebSession` attributes. Annotations @Nullable Since 5.1

public Predicate<String> getSessionAttributePredicate()

Return the configured predicate for initialization WebSocket session attributes from WebSession attributes.

Annotations

@Nullable

Since

5.1

getUpgradeStrategy	back to summary
public RequestUpgradeStrategy getUpgradeStrategy() Return the `RequestUpgradeStrategy` for WebSocket requests.

handleBadRequest	back to summary
private Mono<Void> handleBadRequest(ServerWebExchange exchange, String reason)

handleRequest back to summary

handleRequest	back to summary
public Mono<Void> handleRequest(ServerWebExchange exchange, WebSocketHandler handler) Implements org.springframework.web.reactive.socket.server.WebSocketService.handleRequest. Doc from org.springframework.web.reactive.socket.server.WebSocketService.handleRequest. Handle the request with the given `WebSocketHandler`. Parameters exchange:ServerWebExchange the current exchange handler:WebSocketHandler handler for WebSocket session Returns:Mono<Void> a `Mono<Void>` that completes when application handling of the WebSocket session completes. Annotations @Override

public Mono<Void> handleRequest(ServerWebExchange exchange, WebSocketHandler handler)

Implements org.springframework.web.reactive.socket.server.WebSocketService.handleRequest.

Doc from org.springframework.web.reactive.socket.server.WebSocketService.handleRequest.

Handle the request with the given WebSocketHandler.

Parameters

exchange:ServerWebExchange: the current exchange
handler:WebSocketHandler: handler for WebSocket session

Returns:Mono<Void>

a Mono<Void> that completes when application handling of the WebSocket session completes.

Annotations

@Override

initAttributes	back to summary
private Mono<Map<String, Object>> initAttributes(ServerWebExchange exchange)

initUpgradeStrategy	back to summary
pack-priv static RequestUpgradeStrategy initUpgradeStrategy()

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

selectProtocol	back to summary
private String selectProtocol(HttpHeaders headers, WebSocketHandler handler) Annotations @Nullable

setSessionAttributePredicate back to summary

setSessionAttributePredicate	back to summary
public void setSessionAttributePredicate(Predicate<String> predicate) Configure a predicate to use to extract `WebSession` attributes and use them to initialize the WebSocket session with. By default this is not set in which case no attributes are passed. Parameters predicate:Predicate<String> the predicate Since 5.1

public void setSessionAttributePredicate(Predicate<String> predicate)

Configure a predicate to use to extract WebSession attributes and use them to initialize the WebSocket session with.

By default this is not set in which case no attributes are passed.

Parameters

predicate:Predicate<String>: the predicate

Since

5.1

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.reactive.socket.server.support back to summary

private Class HandshakeWebSocketService.ReactorNettyStrategyDelegate

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService.ReactorNettyStrategyDelegate

Inner class to avoid a reachable dependency on Reactor Netty API.

Constructor Summary

Access	Constructor and Description
private	ReactorNettyStrategyDelegate()

Method Summary

Modifier and Type	Method and Description
public static RequestUpgradeStrategy	forReactorNetty1()
public static RequestUpgradeStrategy	forReactorNetty2()

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

Constructor Detail

ReactorNettyStrategyDelegate	back to summary
private ReactorNettyStrategyDelegate()

Method Detail

forReactorNetty1	back to summary
public static RequestUpgradeStrategy forReactorNetty1()

forReactorNetty2	back to summary
public static RequestUpgradeStrategy forReactorNetty2()

public Class HandshakeWebSocketService

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HandshakeWebSocketService.ReactorNettyStrategyDelegate

Constructor Summary

Method Summary

Constructor Detail

Method Detail