Interface StompEndpointRegistry
- All Known Implementing Classes:
WebMvcStompEndpointRegistry
public interface StompEndpointRegistry
A contract for registering STOMP over WebSocket endpoints.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StompWebSocketEndpointRegistrationaddEndpoint(String... paths)Register a STOMP over WebSocket endpoint at the given mapping path.WebMvcStompEndpointRegistrysetErrorHandler(StompSubProtocolErrorHandler errorHandler)Configure a handler for customizing or handling STOMP ERROR frames to clients.voidsetOrder(int order)Set the order of theHandlerMappingused for STOMP endpoints relative to other Spring MVC handler mappings.voidsetUrlPathHelper(UrlPathHelper urlPathHelper)Configure a customizedUrlPathHelperfor the STOMP endpointHandlerMapping.
Method Detail
addEndpoint
StompWebSocketEndpointRegistration addEndpoint(String... paths)
Register a STOMP over WebSocket endpoint at the given mapping path.
setOrder
void setOrder(int order)
Set the order of theHandlerMappingused for STOMP endpoints relative to other Spring MVC handler mappings.By default this is set to 1.
setUrlPathHelper
void setUrlPathHelper(UrlPathHelper urlPathHelper)
Configure a customizedUrlPathHelperfor the STOMP endpointHandlerMapping.
setErrorHandler
WebMvcStompEndpointRegistry setErrorHandler(StompSubProtocolErrorHandler errorHandler)
Configure a handler for customizing or handling STOMP ERROR frames to clients.- Parameters:
errorHandler- the error handler- Since:
- 4.2