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 java.lang.Object
implements StompWebSocketEndpointRegistration

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

Since:

4.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	WebMvcStompWebSocketEndpointRegistration.StompSockJsServiceRegistration

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	allowedOrigins
private HandshakeHandler	handshakeHandler
private java.util.List<HandshakeInterceptor>	interceptors
private java.lang.String[]	paths
private WebMvcStompWebSocketEndpointRegistration.StompSockJsServiceRegistration	registration
private TaskScheduler	sockJsTaskScheduler
private WebSocketHandler	webSocketHandler

Constructor Summary

Constructors

Constructor and Description
WebMvcStompWebSocketEndpointRegistration(java.lang.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,java.lang.String>	getMappings()
StompWebSocketEndpointRegistration	setAllowedOrigins(java.lang.String... allowedOrigins) 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

Field Detail

paths

private final java.lang.String[] paths

webSocketHandler

private final WebSocketHandler webSocketHandler

sockJsTaskScheduler

private final TaskScheduler sockJsTaskScheduler

handshakeHandler

private HandshakeHandler handshakeHandler

interceptors

private final java.util.List<HandshakeInterceptor> interceptors

allowedOrigins

private final java.util.List<java.lang.String> allowedOrigins

registration

private WebMvcStompWebSocketEndpointRegistration.StompSockJsServiceRegistration registration

Constructor Detail

WebMvcStompWebSocketEndpointRegistration

public WebMvcStompWebSocketEndpointRegistration(java.lang.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(java.lang.String... allowedOrigins)

Description copied from interface: StompWebSocketEndpointRegistration

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

When SockJS is enabled and origins are restricted, transport types that do not allow to check request origin (JSONP and Iframe based transports) are disabled. As a consequence, IE 6 to 9 are not supported when origins are restricted.

Each provided allowed origin must start by "http://", "https://" or be "*" (means that all origins are allowed). By default, only same origin requests are allowed (empty list).

Specified by:

setAllowedOrigins in interface StompWebSocketEndpointRegistration

See Also:

RFC 6454: The Web Origin Concept, 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,java.lang.String> getMappings()