org.springframework.session.web.socket.config.annotation

Class AbstractSessionWebSocketMessageBrokerConfigurer<S extends ExpiringSession>

java.lang.Object

org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer

org.springframework.session.web.socket.config.annotation.AbstractSessionWebSocketMessageBrokerConfigurer<S>

Type Parameters:

S - the type of ExpiringSession

All Implemented Interfaces:

org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

public abstract class AbstractSessionWebSocketMessageBrokerConfigurer<S extends ExpiringSession>
extends org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer

Eases configuration of Web Socket and Spring Session integration.

The configuration:

• Ensures the Session is kept alive on incoming web socket messages.
• Ensures that Web Socket Sessions are destroyed when a Session is terminated

Example usage

@Configuration @EnableScheduling @EnableWebSocketMessageBroker public class WebSocketConfig<S extends ExpiringSession> extends AbstractSessionWebSocketMessageBrokerConfigurer<S> { @Override protected void configureStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/messages") .withSockJS(); } @Override public void configureMessageBroker(MessageBrokerRegistry registry) { registry.enableSimpleBroker("/queue/", "/topic/"); registry.setApplicationDestinationPrefixes("/app"); } }

Since:

1.0

Author:

Rob Winch

Constructor Summary

Constructors

Constructor and Description
AbstractSessionWebSocketMessageBrokerConfigurer()

Method Summary

Modifier and Type	Method and Description
void	configureClientInboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)
protected abstract void	configureStompEndpoints(org.springframework.web.socket.config.annotation.StompEndpointRegistry registry) Register STOMP endpoints mapping each to a specific URL and (optionally) enabling and configuring SockJS fallback options with a SessionRepositoryMessageInterceptor automatically added as an interceptor.
void	configureWebSocketTransport(org.springframework.web.socket.config.annotation.WebSocketTransportRegistration registration)
void	registerStompEndpoints(org.springframework.web.socket.config.annotation.StompEndpointRegistry registry)
SessionRepositoryMessageInterceptor<S>	sessionRepositoryInterceptor()
WebSocketRegistryListener	webSocketRegistryListener()
WebSocketConnectHandlerDecoratorFactory	wsConnectHandlerDecoratorFactory()

Methods inherited from class org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer

addArgumentResolvers, addReturnValueHandlers, configureClientOutboundChannel, configureMessageBroker, configureMessageConverters

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSessionWebSocketMessageBrokerConfigurer

public AbstractSessionWebSocketMessageBrokerConfigurer()

Method Detail

configureClientInboundChannel

public void configureClientInboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)

Specified by:

configureClientInboundChannel in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Overrides:

configureClientInboundChannel in class org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer

registerStompEndpoints

public final void registerStompEndpoints(org.springframework.web.socket.config.annotation.StompEndpointRegistry registry)

configureStompEndpoints

protected abstract void configureStompEndpoints(org.springframework.web.socket.config.annotation.StompEndpointRegistry registry)

Register STOMP endpoints mapping each to a specific URL and (optionally) enabling and configuring SockJS fallback options with a SessionRepositoryMessageInterceptor automatically added as an interceptor.

Parameters:

registry - the StompEndpointRegistry which automatically has a SessionRepositoryMessageInterceptor added to it.

configureWebSocketTransport

public void configureWebSocketTransport(org.springframework.web.socket.config.annotation.WebSocketTransportRegistration registration)

Specified by:

configureWebSocketTransport in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Overrides:

configureWebSocketTransport in class org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer

webSocketRegistryListener

@Bean
public WebSocketRegistryListener webSocketRegistryListener()

wsConnectHandlerDecoratorFactory

@Bean
public WebSocketConnectHandlerDecoratorFactory wsConnectHandlerDecoratorFactory()

sessionRepositoryInterceptor

@Bean
public SessionRepositoryMessageInterceptor<S> sessionRepositoryInterceptor()