org.springframework.web.socket.config.annotation

Interface StompWebSocketEndpointRegistration

All Known Implementing Classes:

WebMvcStompWebSocketEndpointRegistration

public interface StompWebSocketEndpointRegistration

A contract for configuring a STOMP over WebSocket endpoint.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
StompWebSocketEndpointRegistration	addInterceptors(HandshakeInterceptor... interceptors) Configure the HandshakeInterceptor's to use.
StompWebSocketEndpointRegistration	setAllowedOrigins(String... origins) Configure allowed Origin header values.
StompWebSocketEndpointRegistration	setHandshakeHandler(HandshakeHandler handshakeHandler) Configure the HandshakeHandler to use.
SockJsServiceRegistration	withSockJS() Enable SockJS fallback options.

Method Detail

withSockJS

SockJsServiceRegistration withSockJS()

Enable SockJS fallback options.

setHandshakeHandler

StompWebSocketEndpointRegistration setHandshakeHandler(HandshakeHandler handshakeHandler)

Configure the HandshakeHandler to use.

addInterceptors

StompWebSocketEndpointRegistration addInterceptors(HandshakeInterceptor... interceptors)

Configure the HandshakeInterceptor's to use.

setAllowedOrigins

StompWebSocketEndpointRegistration setAllowedOrigins(String... origins)

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.

Since:

4.1.2

See Also:

SockJS supported transports by browser