org.springframework.web.socket.config.annotation

Class ServletWebSocketHandlerRegistry

java.lang.Object

org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

All Implemented Interfaces:

WebSocketHandlerRegistry

public class ServletWebSocketHandlerRegistry
extends java.lang.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 and Description
ServletWebSocketHandlerRegistry()
ServletWebSocketHandlerRegistry(ThreadPoolTaskScheduler scheduler) Deprecated. as of 5.0 a TaskScheduler is not provided upfront, not until it is obvious that it is needed, see requiresTaskScheduler() and setTaskScheduler(org.springframework.scheduling.TaskScheduler).

Method Summary

Modifier and Type	Method and Description
WebSocketHandlerRegistration	addHandler(WebSocketHandler handler, java.lang.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 resulting SimpleUrlHandlerMapping relative to other handler mappings configured in Spring MVC.
protected void	setTaskScheduler(TaskScheduler scheduler) Configure a TaskScheduler for SockJS endpoints.
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()

ServletWebSocketHandlerRegistry

@Deprecated
public ServletWebSocketHandlerRegistry(ThreadPoolTaskScheduler scheduler)

Deprecated. as of 5.0 a TaskScheduler is not provided upfront, not until it is obvious that it is needed, see requiresTaskScheduler() and setTaskScheduler(org.springframework.scheduling.TaskScheduler).

Deprecated constructor with a TaskScheduler for SockJS use.

Method Detail

addHandler

public WebSocketHandlerRegistration addHandler(WebSocketHandler handler,
                                               java.lang.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(@Nullable
                             UrlPathHelper urlPathHelper)

Set the UrlPathHelper to configure on the SimpleUrlHandlerMapping 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 before getHandlerMapping() to allow for registrations to be made first.

setTaskScheduler

protected void setTaskScheduler(TaskScheduler scheduler)

Configure a TaskScheduler for SockJS endpoints. This should be configured before calling getHandlerMapping() after checking if requiresTaskScheduler() returns true.

getHandlerMapping

public AbstractHandlerMapping getHandlerMapping()