public abstract class AbstractWebSocketHandlerRegistration<M> extends java.lang.Object implements WebSocketHandlerRegistration
WebSocketHandlerRegistration
s that gathers all the configuration
options but allows sub-classes to put together the actual HTTP request mappings.Modifier and Type | Field and Description |
---|---|
private MultiValueMap<WebSocketHandler,java.lang.String> |
handlerMap |
private HandshakeHandler |
handshakeHandler |
private HandshakeInterceptor[] |
interceptors |
private SockJsServiceRegistration |
sockJsServiceRegistration |
private TaskScheduler |
sockJsTaskScheduler |
Constructor and Description |
---|
AbstractWebSocketHandlerRegistration(TaskScheduler defaultTaskScheduler) |
Modifier and Type | Method and Description |
---|---|
WebSocketHandlerRegistration |
addHandler(WebSocketHandler handler,
java.lang.String... paths)
Add more handlers that will share the same configuration (interceptors, SockJS
config, etc)
|
WebSocketHandlerRegistration |
addInterceptors(HandshakeInterceptor... interceptors)
Configure interceptors for the handshake request.
|
protected abstract void |
addSockJsServiceMapping(M mappings,
SockJsService sockJsService,
WebSocketHandler handler,
java.lang.String pathPattern) |
protected abstract void |
addWebSocketHandlerMapping(M mappings,
WebSocketHandler wsHandler,
HandshakeHandler handshakeHandler,
HandshakeInterceptor[] interceptors,
java.lang.String path) |
protected abstract M |
createMappings() |
HandshakeHandler |
getHandshakeHandler() |
protected HandshakeInterceptor[] |
getInterceptors() |
M |
getMappings() |
private HandshakeHandler |
getOrCreateHandshakeHandler() |
WebSocketHandlerRegistration |
setHandshakeHandler(HandshakeHandler handshakeHandler)
Configure the HandshakeHandler to use.
|
void |
setInterceptors(HandshakeInterceptor[] interceptors) |
SockJsServiceRegistration |
withSockJS()
Enable SockJS fallback options.
|
private MultiValueMap<WebSocketHandler,java.lang.String> handlerMap
private HandshakeInterceptor[] interceptors
private HandshakeHandler handshakeHandler
private SockJsServiceRegistration sockJsServiceRegistration
private final TaskScheduler sockJsTaskScheduler
public AbstractWebSocketHandlerRegistration(TaskScheduler defaultTaskScheduler)
public WebSocketHandlerRegistration addHandler(WebSocketHandler handler, java.lang.String... paths)
WebSocketHandlerRegistration
addHandler
in interface WebSocketHandlerRegistration
public WebSocketHandlerRegistration setHandshakeHandler(HandshakeHandler handshakeHandler)
WebSocketHandlerRegistration
setHandshakeHandler
in interface WebSocketHandlerRegistration
public HandshakeHandler getHandshakeHandler()
public WebSocketHandlerRegistration addInterceptors(HandshakeInterceptor... interceptors)
WebSocketHandlerRegistration
addInterceptors
in interface WebSocketHandlerRegistration
protected HandshakeInterceptor[] getInterceptors()
public void setInterceptors(HandshakeInterceptor[] interceptors)
interceptors
- the interceptors to setpublic SockJsServiceRegistration withSockJS()
WebSocketHandlerRegistration
withSockJS
in interface WebSocketHandlerRegistration
public final M getMappings()
private HandshakeHandler getOrCreateHandshakeHandler()
protected abstract M createMappings()
protected abstract void addSockJsServiceMapping(M mappings, SockJsService sockJsService, WebSocketHandler handler, java.lang.String pathPattern)
protected abstract void addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, java.lang.String path)