ServletWebSocketHandlerRegistry (Spring Framework 4.3.30.RELEASE API)

java.lang.Object
- org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

All Implemented Interfaces:
WebSocketHandlerRegistry
```
public class ServletWebSocketHandlerRegistry
extends Object
implements WebSocketHandlerRegistry
```
A WebSocketHandlerRegistry that maps WebSocketHandlers to URLs for use in a Servlet container.
Since:
4.0
Author:
Rossen Stoyanchev

Constructor Summary
Constructors
Constructor Description
ServletWebSocketHandlerRegistry(ThreadPoolTaskScheduler sockJsTaskScheduler)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebSocketHandlerRegistration`	`addHandler(WebSocketHandler webSocketHandler, String... paths)`	Configure a WebSocketHandler at the specified URL paths.
`AbstractHandlerMapping`	`getHandlerMapping()`	Return a `HandlerMapping` with mapped `HttpRequestHandler`s.
`int`	`getOrder()`
`UrlPathHelper`	`getUrlPathHelper()`
`void`	`setOrder(int order)`	Set the order for the resulting `SimpleUrlHandlerMapping` relative to other handler mappings configured in Spring MVC.
`void`	`setUrlPathHelper(UrlPathHelper urlPathHelper)`	Set the UrlPathHelper to configure on the `SimpleUrlHandlerMapping` used to map handshake requests.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletWebSocketHandlerRegistry
```
public ServletWebSocketHandlerRegistry(ThreadPoolTaskScheduler sockJsTaskScheduler)
```
- Method Detail
  - addHandler
```
public WebSocketHandlerRegistration addHandler(WebSocketHandler webSocketHandler,
                                               String... paths)
```
    Description copied from interface: WebSocketHandlerRegistry
    Configure a WebSocketHandler at the specified URL paths.
    Specified by:
    addHandler in interface WebSocketHandlerRegistry
  - setOrder
```
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.
  - getOrder
```
public int getOrder()
```
  - setUrlPathHelper
```
public void setUrlPathHelper(UrlPathHelper urlPathHelper)
```
    Set the UrlPathHelper to configure on the SimpleUrlHandlerMapping used to map handshake requests.
  - getUrlPathHelper
```
public UrlPathHelper getUrlPathHelper()
```
  - getHandlerMapping
```
public AbstractHandlerMapping getHandlerMapping()
```
    Return a HandlerMapping with mapped HttpRequestHandlers.