org.springframework.web.socket.config.annotation

Interface WebSocketHandlerRegistration

All Known Implementing Classes:

AbstractWebSocketHandlerRegistration, ServletWebSocketHandlerRegistration

public interface WebSocketHandlerRegistration

Provides methods for configuring a WebSocket handler.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
WebSocketHandlerRegistration	addHandler(WebSocketHandler handler, 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.
WebSocketHandlerRegistration	setHandshakeHandler(HandshakeHandler handshakeHandler) Configure the HandshakeHandler to use.
SockJsServiceRegistration	withSockJS() Enable SockJS fallback options.

Method Detail

addHandler

WebSocketHandlerRegistration addHandler(WebSocketHandler handler,
                                        String... paths)

Add more handlers that will share the same configuration (interceptors, SockJS config, etc)

addInterceptors

WebSocketHandlerRegistration addInterceptors(HandshakeInterceptor... interceptors)

Configure interceptors for the handshake request.

setHandshakeHandler

WebSocketHandlerRegistration setHandshakeHandler(HandshakeHandler handshakeHandler)

Configure the HandshakeHandler to use.

withSockJS

SockJsServiceRegistration withSockJS()

Enable SockJS fallback options.