Class AbstractWebSocketHandlerRegistration<M>

java.lang.Object

org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration<M>

Type Parameters:

M - the mappings type

All Implemented Interfaces:

WebSocketHandlerRegistration

Direct Known Subclasses:

ServletWebSocketHandlerRegistration

public abstract class AbstractWebSocketHandlerRegistration<M>
extends Object
implements WebSocketHandlerRegistration

Base class for WebSocketHandlerRegistrations that gathers all the configuration options but allows subclasses to put together the actual HTTP request mappings.

Since:

4.0

Author:

Rossen Stoyanchev, Sebastien Deleuze

Constructor Summary

Constructors

Constructor	Description
AbstractWebSocketHandlerRegistration()

Method Summary

Modifier and Type	Method	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.
protected abstract void	addSockJsServiceMapping(M mappings, SockJsService sockJsService, WebSocketHandler handler, String pathPattern)
protected abstract void	addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)
protected abstract M	createMappings()
protected @Nullable HandshakeHandler	getHandshakeHandler()
protected HandshakeInterceptor[]	getInterceptors()
protected final M	getMappings()
protected @Nullable SockJsServiceRegistration	getSockJsServiceRegistration()	Expose the SockJsServiceRegistration -- if SockJS is enabled or null otherwise -- so that it can be configured with a TaskScheduler if the application did not provide one.
WebSocketHandlerRegistration	setAllowedOriginPatterns(String... allowedOriginPatterns)	Alternative to WebSocketHandlerRegistration.setAllowedOrigins(String...) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser.
WebSocketHandlerRegistration	setAllowedOrigins(String... allowedOrigins)	Set the origins for which cross-origin requests are allowed from a browser.
WebSocketHandlerRegistration	setHandshakeHandler(@Nullable HandshakeHandler handshakeHandler)	Configure the HandshakeHandler to use.
SockJsServiceRegistration	withSockJS()	Enable SockJS fallback options.

Methods inherited from class Object

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

Constructor Details

AbstractWebSocketHandlerRegistration

public AbstractWebSocketHandlerRegistration()

Method Details

addHandler

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

Description copied from interface: WebSocketHandlerRegistration

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

Specified by:

addHandler in interface WebSocketHandlerRegistration

setHandshakeHandler

public WebSocketHandlerRegistration setHandshakeHandler(@Nullable HandshakeHandler handshakeHandler)

Description copied from interface: WebSocketHandlerRegistration

Configure the HandshakeHandler to use.

Specified by:

setHandshakeHandler in interface WebSocketHandlerRegistration

getHandshakeHandler

protected @Nullable HandshakeHandler getHandshakeHandler()

addInterceptors

public WebSocketHandlerRegistration addInterceptors(HandshakeInterceptor... interceptors)

Description copied from interface: WebSocketHandlerRegistration

Configure interceptors for the handshake request.

Specified by:

addInterceptors in interface WebSocketHandlerRegistration

setAllowedOrigins

public WebSocketHandlerRegistration setAllowedOrigins(String... allowedOrigins)

Description copied from interface: WebSocketHandlerRegistration

Set the origins for which cross-origin requests are allowed from a browser. Please, refer to CorsConfiguration.setAllowedOrigins(List) for format details and considerations, and keep in mind that the CORS spec does not allow use of "*" with allowCredentials=true. For more flexible origin patterns use WebSocketHandlerRegistration.setAllowedOriginPatterns(String...) instead.

By default, no origins are allowed. When allowedOriginPatterns is also set, then that takes precedence over this property.

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

Specified by:

setAllowedOrigins in interface WebSocketHandlerRegistration

See Also:

• WebSocketHandlerRegistration.setAllowedOriginPatterns(String...)
• RFC 6454: The Web Origin Concept
• SockJS supported transports by browser

setAllowedOriginPatterns

public WebSocketHandlerRegistration setAllowedOriginPatterns(String... allowedOriginPatterns)

Description copied from interface: WebSocketHandlerRegistration

Alternative to WebSocketHandlerRegistration.setAllowedOrigins(String...) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser. Please, refer to CorsConfiguration.setAllowedOriginPatterns(List) for format details and other considerations.

By default this is not set.

Specified by:

setAllowedOriginPatterns in interface WebSocketHandlerRegistration

withSockJS

public SockJsServiceRegistration withSockJS()

Description copied from interface: WebSocketHandlerRegistration

Enable SockJS fallback options.

Specified by:

withSockJS in interface WebSocketHandlerRegistration

getInterceptors

protected HandshakeInterceptor[] getInterceptors()

getSockJsServiceRegistration

protected @Nullable SockJsServiceRegistration getSockJsServiceRegistration()

Expose the SockJsServiceRegistration -- if SockJS is enabled or null otherwise -- so that it can be configured with a TaskScheduler if the application did not provide one. This should be done prior to calling getMappings().

getMappings

protected final M getMappings()

createMappings

protected abstract M createMappings()

addSockJsServiceMapping

protected abstract void addSockJsServiceMapping(M mappings,
 SockJsService sockJsService,
 WebSocketHandler handler,
 String pathPattern)

addWebSocketHandlerMapping

protected abstract void addWebSocketHandlerMapping(M mappings,
 WebSocketHandler wsHandler,
 HandshakeHandler handshakeHandler,
 HandshakeInterceptor[] interceptors,
 String path)