Package org.springframework.web.socket.config.annotation

Class WebMvcStompEndpointRegistry

java.lang.Object

org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

All Implemented Interfaces:

StompEndpointRegistry

public class WebMvcStompEndpointRegistry
extends Object
implements StompEndpointRegistry

A registry for STOMP over WebSocket endpoints that maps the endpoints with a HandlerMapping for use in Spring MVC.

Since:

4.0

Author:

Rossen Stoyanchev, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler, WebSocketTransportRegistration transportRegistration, TaskScheduler defaultSockJsTaskScheduler)

Method Summary

Modifier and Type	Method	Description
StompWebSocketEndpointRegistration	addEndpoint(String... paths)	Register a STOMP over WebSocket endpoint at the given mapping path.
AbstractHandlerMapping	getHandlerMapping()	Return a handler mapping with the mapped ViewControllers.
protected int	getOrder()
protected @Nullable UrlPathHelper	getUrlPathHelper()	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	isPreserveReceiveOrder()
protected void	setApplicationContext(ApplicationContext applicationContext)
WebMvcStompEndpointRegistry	setErrorHandler(StompSubProtocolErrorHandler errorHandler)	Configure a handler for customizing or handling STOMP ERROR frames to clients.
void	setOrder(int order)	Set the order for the resulting HandlerMapping relative to other handler mappings configured in Spring MVC.
WebMvcStompEndpointRegistry	setPreserveReceiveOrder(boolean preserveReceiveOrder)	Whether to handle client messages sequentially in the order in which they were received.
void	setUrlPathHelper(@Nullable UrlPathHelper urlPathHelper)	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebMvcStompEndpointRegistry

public WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler,
 WebSocketTransportRegistration transportRegistration,
 TaskScheduler defaultSockJsTaskScheduler)

Method Details

addEndpoint

public StompWebSocketEndpointRegistration addEndpoint(String... paths)

Description copied from interface: StompEndpointRegistry

Register a STOMP over WebSocket endpoint at the given mapping path.

Specified by:

addEndpoint in interface StompEndpointRegistry

setOrder

public void setOrder(int order)

Set the order for the resulting HandlerMapping relative to other handler mappings configured in Spring MVC.

The default value is 1.

Specified by:

setOrder in interface StompEndpointRegistry

getOrder

protected int getOrder()

setUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
public void setUrlPathHelper(@Nullable UrlPathHelper urlPathHelper)

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Set the UrlPathHelper to configure on the HandlerMapping used to map handshake requests.

Specified by:

setUrlPathHelper in interface StompEndpointRegistry

getUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
protected @Nullable UrlPathHelper getUrlPathHelper()

Deprecated, for removal: This API element is subject to removal in a future version.

setErrorHandler

public WebMvcStompEndpointRegistry setErrorHandler(StompSubProtocolErrorHandler errorHandler)

Description copied from interface: StompEndpointRegistry

Configure a handler for customizing or handling STOMP ERROR frames to clients.

Specified by:

setErrorHandler in interface StompEndpointRegistry

Parameters:

errorHandler - the error handler

setPreserveReceiveOrder

public WebMvcStompEndpointRegistry setPreserveReceiveOrder(boolean preserveReceiveOrder)

Description copied from interface: StompEndpointRegistry

Whether to handle client messages sequentially in the order in which they were received.

By default messages sent to the "clientInboundChannel" may be handled in parallel and not in the same order as they were received because the channel is backed by a ThreadPoolExecutor that in turn does not guarantee processing in order.

When this flag is set to true messages within the same session will be sent to the "clientInboundChannel" one at a time in order to preserve the order in which they were received.

Specified by:

setPreserveReceiveOrder in interface StompEndpointRegistry

isPreserveReceiveOrder

protected boolean isPreserveReceiveOrder()

setApplicationContext

protected void setApplicationContext(ApplicationContext applicationContext)

getHandlerMapping

public AbstractHandlerMapping getHandlerMapping()

Return a handler mapping with the mapped ViewControllers.