spring-framework / org.springframework.web.socket.server.support / WebSocketHandlerMapping

WebSocketHandlerMapping

open class WebSocketHandlerMapping : SimpleUrlHandlerMapping, SmartLifecycle

An extension of SimpleUrlHandlerMapping that is also a SmartLifecycle container and propagates start and stop calls to any handlers that implement Lifecycle. The handlers are typically expected to be WebSocketHttpRequestHandler or SockJsHttpRequestHandler.

Author
Rossen Stoyanchev

Since
4.2

Constructors

<init>

WebSocketHandlerMapping()

Functions

getPhase	`open fun getPhase(): Int`
isAutoStartup	`open fun isAutoStartup(): Boolean`
isRunning	`open fun isRunning(): Boolean`
start	`open fun start(): Unit`
stop	`open fun stop(): Unit` `open fun stop(callback: Runnable): Unit`

Inherited Functions

getUrlMap	`open fun getUrlMap(): MutableMap<String, *>` Allow Map access to the URL path mappings, with the option to add or override specific entries. Useful for specifying entries directly, for example via "urlMap[myKey]". This is particularly useful for adding or overriding entries in child bean definitions.
initApplicationContext	`open fun initApplicationContext(): Unit` Calls the `#registerHandlers` method in addition to the superclass's initialization.
setMappings	`open fun setMappings(mappings: Properties): Unit` Map URL paths to handler bean names. This is the typical way of configuring this HandlerMapping. Supports direct URL matches and Ant-style pattern matches. For syntax details, see the org.springframework.util.AntPathMatcher javadoc.
setUrlMap	`open fun setUrlMap(urlMap: MutableMap<String, *>): Unit` Set a Map with URL paths as keys and handler beans (or handler bean names) as values. Convenient for population with bean references. Supports direct URL matches and Ant-style pattern matches. For syntax details, see the org.springframework.util.AntPathMatcher javadoc.