ch.rasc.wampspring.config

Class WebMvcWampWebSocketEndpointRegistration

java.lang.Object

ch.rasc.wampspring.config.WebMvcWampWebSocketEndpointRegistration

All Implemented Interfaces:

WampWebSocketEndpointRegistration

public class WebMvcWampWebSocketEndpointRegistration
extends Object
implements WampWebSocketEndpointRegistration

Author:

Rossen Stoyanchev, Ralph Schaer

Constructor Summary

Constructors

Constructor and Description
WebMvcWampWebSocketEndpointRegistration(String[] paths, org.springframework.web.socket.WebSocketHandler webSocketHandler, org.springframework.scheduling.TaskScheduler sockJsTaskScheduler)

Method Summary

Modifier and Type	Method and Description
WampWebSocketEndpointRegistration	addInterceptors(org.springframework.web.socket.server.HandshakeInterceptor... handshakeInterceptors) Configure the HandshakeInterceptor's to use.
protected org.springframework.web.socket.server.HandshakeInterceptor[]	getInterceptors()
org.springframework.util.MultiValueMap<org.springframework.web.HttpRequestHandler,String>	getMappings()
WampWebSocketEndpointRegistration	setAllowedOrigins(String... origins) Configure allowed Origin header values.
WampWebSocketEndpointRegistration	setHandshakeHandler(org.springframework.web.socket.server.HandshakeHandler handshakeHandler) Configure the HandshakeHandler to use.
org.springframework.web.socket.config.annotation.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

WebMvcWampWebSocketEndpointRegistration

public WebMvcWampWebSocketEndpointRegistration(String[] paths,
                                               org.springframework.web.socket.WebSocketHandler webSocketHandler,
                                               org.springframework.scheduling.TaskScheduler sockJsTaskScheduler)

Method Detail

setHandshakeHandler

public WampWebSocketEndpointRegistration setHandshakeHandler(org.springframework.web.socket.server.HandshakeHandler handshakeHandler)

Description copied from interface: WampWebSocketEndpointRegistration

Configure the HandshakeHandler to use.

Specified by:

setHandshakeHandler in interface WampWebSocketEndpointRegistration

addInterceptors

public WampWebSocketEndpointRegistration addInterceptors(org.springframework.web.socket.server.HandshakeInterceptor... handshakeInterceptors)

Description copied from interface: WampWebSocketEndpointRegistration

Configure the HandshakeInterceptor's to use.

Specified by:

addInterceptors in interface WampWebSocketEndpointRegistration

setAllowedOrigins

public WampWebSocketEndpointRegistration setAllowedOrigins(String... origins)

Description copied from interface: WampWebSocketEndpointRegistration

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 WampWebSocketEndpointRegistration

withSockJS

public org.springframework.web.socket.config.annotation.SockJsServiceRegistration withSockJS()

Description copied from interface: WampWebSocketEndpointRegistration

Enable SockJS fallback options.

Specified by:

withSockJS in interface WampWebSocketEndpointRegistration

getInterceptors

protected org.springframework.web.socket.server.HandshakeInterceptor[] getInterceptors()

getMappings

public final org.springframework.util.MultiValueMap<org.springframework.web.HttpRequestHandler,String> getMappings()