Spring Framework 6.1.4 · org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

Modifier and Type	Field and Description
private int	order
private final List<ServletWebSocketHandlerRegistration>	registrations
private UrlPathHelper	urlPathHelper

Access	Constructor and Description
public	ServletWebSocketHandlerRegistry()

Method Summary

Modifier and Type	Method and Description
public WebSocketHandlerRegistration	addHandler(WebSocketHandler handler, String... paths) Implements org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry.addHandler. Configure a WebSocketHandler at the specified URL paths.
public AbstractHandlerMapping	getHandlerMapping()
public int	getOrder()
public UrlPathHelper	getUrlPathHelper()
protected boolean	requiresTaskScheduler() Whether there are any endpoint SockJS registrations without a TaskScheduler.
public void	setOrder(int order) Set the order for the resulting `SimpleUrlHandlerMapping` relative to other handler mappings configured in Spring MVC.
protected void	setTaskScheduler(TaskScheduler scheduler) Provide the TaskScheduler to use for SockJS endpoints for which a task scheduler has not been explicitly registered.
public void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to configure on the `SimpleUrlHandlerMapping` used to map handshake requests.

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

order	back to summary
private int order

registrations	back to summary
private final List<ServletWebSocketHandlerRegistration> registrations

urlPathHelper	back to summary
private UrlPathHelper urlPathHelper Annotations @Nullable

ServletWebSocketHandlerRegistry	back to summary
public ServletWebSocketHandlerRegistry()

addHandler	back to summary
public WebSocketHandlerRegistration addHandler(WebSocketHandler handler, String... paths) Implements org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry.addHandler. Doc from org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry.addHandler. Configure a WebSocketHandler at the specified URL paths. Annotations @Override

addHandler

Configure a WebSocketHandler at the specified URL paths.

Annotations

getHandlerMapping	back to summary
public AbstractHandlerMapping getHandlerMapping()

getOrder	back to summary
public int getOrder()

getUrlPathHelper	back to summary
public UrlPathHelper getUrlPathHelper() Annotations @Nullable

requiresTaskScheduler	back to summary
protected boolean requiresTaskScheduler() Whether there are any endpoint SockJS registrations without a TaskScheduler. This method should be invoked just before `getHandlerMapping()` to allow for registrations to be made first.

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Set the order for the resulting `SimpleUrlHandlerMapping` relative to other handler mappings configured in Spring MVC. The default value is 1.

public void setOrder(int order)

Set the order for the resulting SimpleUrlHandlerMapping relative to other handler mappings configured in Spring MVC.

The default value is 1.

setTaskScheduler	back to summary
protected void setTaskScheduler(TaskScheduler scheduler) Provide the TaskScheduler to use for SockJS endpoints for which a task scheduler has not been explicitly registered. This method must be called prior to `getHandlerMapping()`.

setUrlPathHelper	back to summary
public void setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to configure on the `SimpleUrlHandlerMapping` used to map handshake requests.