org.springframework.web.socket.config.annotation

Class ServletWebSocketHandlerRegistration

java.lang.Object

org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration<MultiValueMap<HttpRequestHandler,java.lang.String>>

org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

All Implemented Interfaces:

WebSocketHandlerRegistration

public class ServletWebSocketHandlerRegistration
extends AbstractWebSocketHandlerRegistration<MultiValueMap<HttpRequestHandler,java.lang.String>>

A helper class for configuring WebSocketHandler request handling including SockJS fallback options.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ServletWebSocketHandlerRegistration()
ServletWebSocketHandlerRegistration(TaskScheduler scheduler) Deprecated. as of 5.0 a TaskScheduler is not provided upfront, not until it is obvious that it is needed, see AbstractWebSocketHandlerRegistration.getSockJsServiceRegistration().

Method Summary

Modifier and Type	Method and Description
protected void	addSockJsServiceMapping(MultiValueMap<HttpRequestHandler,java.lang.String> mappings, SockJsService sockJsService, WebSocketHandler handler, java.lang.String pathPattern)
protected void	addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler,java.lang.String> mappings, WebSocketHandler webSocketHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, java.lang.String path)
protected MultiValueMap<HttpRequestHandler,java.lang.String>	createMappings()

Methods inherited from class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

addHandler, addInterceptors, getHandshakeHandler, getInterceptors, getMappings, getSockJsServiceRegistration, setAllowedOrigins, setHandshakeHandler, withSockJS

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletWebSocketHandlerRegistration

public ServletWebSocketHandlerRegistration()

ServletWebSocketHandlerRegistration

@Deprecated
public ServletWebSocketHandlerRegistration(TaskScheduler scheduler)

Deprecated. as of 5.0 a TaskScheduler is not provided upfront, not until it is obvious that it is needed, see AbstractWebSocketHandlerRegistration.getSockJsServiceRegistration().

Deprecated constructor with a TaskScheduler for SockJS use.

Method Detail

createMappings

protected MultiValueMap<HttpRequestHandler,java.lang.String> createMappings()

Specified by:

createMappings in class AbstractWebSocketHandlerRegistration<MultiValueMap<HttpRequestHandler,java.lang.String>>

addSockJsServiceMapping

protected void addSockJsServiceMapping(MultiValueMap<HttpRequestHandler,java.lang.String> mappings,
                                       SockJsService sockJsService,
                                       WebSocketHandler handler,
                                       java.lang.String pathPattern)

Specified by:

addSockJsServiceMapping in class AbstractWebSocketHandlerRegistration<MultiValueMap<HttpRequestHandler,java.lang.String>>

addWebSocketHandlerMapping

protected void addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler,java.lang.String> mappings,
                                          WebSocketHandler webSocketHandler,
                                          HandshakeHandler handshakeHandler,
                                          HandshakeInterceptor[] interceptors,
                                          java.lang.String path)

Specified by:

addWebSocketHandlerMapping in class AbstractWebSocketHandlerRegistration<MultiValueMap<HttpRequestHandler,java.lang.String>>