org.springframework.web.socket.config.annotation

Class WebMvcStompWebSocketEndpointRegistration

java.lang.Object

org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

All Implemented Interfaces:

StompWebSocketEndpointRegistration

public class WebMvcStompWebSocketEndpointRegistration
extends Object
implements StompWebSocketEndpointRegistration

An abstract base class class for configuring STOMP over WebSocket/SockJS endpoints.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
WebMvcStompWebSocketEndpointRegistration(String[] paths, WebSocketHandler webSocketHandler, TaskScheduler sockJsTaskScheduler)

Method Summary

Modifier and Type	Method and Description
StompWebSocketEndpointRegistration	addInterceptors(HandshakeInterceptor... interceptors) Configure the HandshakeInterceptor's to use.
protected HandshakeInterceptor[]	getInterceptors()
MultiValueMap<HttpRequestHandler,String>	getMappings()
StompWebSocketEndpointRegistration	setAllowedOrigins(String... origins) Configure allowed Origin header values.
StompWebSocketEndpointRegistration	setHandshakeHandler(HandshakeHandler handshakeHandler) Configure the HandshakeHandler to use.
SockJsServiceRegistration	withSockJS() Enable SockJS fallback options.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebMvcStompWebSocketEndpointRegistration

public WebMvcStompWebSocketEndpointRegistration(String[] paths,
                                                WebSocketHandler webSocketHandler,
                                                TaskScheduler sockJsTaskScheduler)

Method Detail

setHandshakeHandler

public StompWebSocketEndpointRegistration setHandshakeHandler(HandshakeHandler handshakeHandler)

Description copied from interface: StompWebSocketEndpointRegistration

Configure the HandshakeHandler to use.

Specified by:

setHandshakeHandler in interface StompWebSocketEndpointRegistration

addInterceptors

public StompWebSocketEndpointRegistration addInterceptors(HandshakeInterceptor... interceptors)

Description copied from interface: StompWebSocketEndpointRegistration

Configure the HandshakeInterceptor's to use.

Specified by:

addInterceptors in interface StompWebSocketEndpointRegistration

setAllowedOrigins

public StompWebSocketEndpointRegistration setAllowedOrigins(String... origins)

Description copied from interface: StompWebSocketEndpointRegistration

Configure allowed Origin header values. This check is mostly designed for browser clients. There is noting preventing other types of client to modify the Origin header value.

When SockJS is enabled and allowed origins are restricted, transport types that do not use Origin headers for cross origin requests (jsonp-polling, iframe-xhr-polling, iframe-eventsource and iframe-htmlfile) are disabled. As a consequence, IE6/IE7 won't be supported anymore and IE8/IE9 will only be supported without cookies.

By default, all origins are allowed.

Specified by:

setAllowedOrigins in interface StompWebSocketEndpointRegistration

See Also:

SockJS supported transports by browser

withSockJS

public SockJsServiceRegistration withSockJS()

Description copied from interface: StompWebSocketEndpointRegistration

Enable SockJS fallback options.

Specified by:

withSockJS in interface StompWebSocketEndpointRegistration

getInterceptors

protected HandshakeInterceptor[] getInterceptors()

getMappings

public final MultiValueMap<HttpRequestHandler,String> getMappings()