Class ServletWebSocketHandlerRegistry
- java.lang.Object
- org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
- All Implemented Interfaces:
WebSocketHandlerRegistry
public class ServletWebSocketHandlerRegistry extends Object implements WebSocketHandlerRegistry
WebSocketHandlerRegistry
with Spring MVC handler mappings for the handshake requests.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description ServletWebSocketHandlerRegistry()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebSocketHandlerRegistration
addHandler(WebSocketHandler handler, String... paths)
Configure a WebSocketHandler at the specified URL paths.AbstractHandlerMapping
getHandlerMapping()
int
getOrder()
UrlPathHelper
getUrlPathHelper()
protected boolean
requiresTaskScheduler()
Whether there are any endpoint SockJS registrations without a TaskScheduler.void
setOrder(int order)
Set the order for the resultingSimpleUrlHandlerMapping
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.void
setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to configure on theSimpleUrlHandlerMapping
used to map handshake requests.
Constructor Detail
ServletWebSocketHandlerRegistry
public ServletWebSocketHandlerRegistry()
Method Detail
addHandler
public WebSocketHandlerRegistration addHandler(WebSocketHandler handler, String... paths)
Description copied from interface:WebSocketHandlerRegistry
Configure a WebSocketHandler at the specified URL paths.- Specified by:
addHandler
in interfaceWebSocketHandlerRegistry
setOrder
public void setOrder(int order)
Set the order for the resultingSimpleUrlHandlerMapping
relative to other handler mappings configured in Spring MVC.The default value is 1.
getOrder
public int getOrder()
setUrlPathHelper
public void setUrlPathHelper(@Nullable UrlPathHelper urlPathHelper)
Set the UrlPathHelper to configure on theSimpleUrlHandlerMapping
used to map handshake requests.
getUrlPathHelper
@Nullable public UrlPathHelper getUrlPathHelper()
requiresTaskScheduler
protected boolean requiresTaskScheduler()
Whether there are any endpoint SockJS registrations without a TaskScheduler. This method should be invoked just beforegetHandlerMapping()
to allow for registrations to be made first.
setTaskScheduler
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 togetHandlerMapping()
.
getHandlerMapping
public AbstractHandlerMapping getHandlerMapping()