类 ServletWebSocketHandlerRegistry
- java.lang.Object
- org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
- 所有已实现的接口:
WebSocketHandlerRegistry
public class ServletWebSocketHandlerRegistry extends Object implements WebSocketHandlerRegistry
WebSocketHandlerRegistry
with Spring MVC handler mappings for the handshake requests.- 从以下版本开始:
- 4.0
- 作者:
- Rossen Stoyanchev
构造器概要
构造器 构造器 说明 ServletWebSocketHandlerRegistry()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 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.
构造器详细资料
ServletWebSocketHandlerRegistry
public ServletWebSocketHandlerRegistry()
方法详细资料
addHandler
public WebSocketHandlerRegistration addHandler(WebSocketHandler handler, String... paths)
从接口复制的说明:WebSocketHandlerRegistry
Configure a WebSocketHandler at the specified URL paths.- 指定者:
addHandler
在接口中WebSocketHandlerRegistry
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()