ch.rasc.wampspring.config

Class DefaultWampConfiguration

java.lang.Object

ch.rasc.wampspring.config.DefaultWampConfiguration

@Configuration
public class DefaultWampConfiguration
extends Object

To enable WAMP support create a @Configuration class that extends this class. Or add EnableWamp to any @Configuration class.

If you overwrite a method annotated with @Bean, don't forget to add the annotation @Bean to the overridden method as well.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.convert.ConversionService	internalConversionService
protected com.fasterxml.jackson.databind.ObjectMapper	internalObjectMapper
protected org.springframework.util.PathMatcher	internalPathMatcher

Constructor Summary

Constructors

Constructor and Description
DefaultWampConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addArgumentResolvers(List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver> argumentResolvers)
protected void	addHandshakeInterceptors(List<org.springframework.web.socket.server.HandshakeInterceptor> handshakeInterceptors)
org.springframework.messaging.MessageHandler	annotationMethodMessageHandler(org.springframework.context.ConfigurableApplicationContext configurableApplicationContext)
AuthenticationHandler	authenticationHandler() Configures an implementation of the AuthenticationHandler interface.
boolean	authenticationRequired() When this method returns true, all calls to a wamp server endpoint (methods annotated with WampCallListener, WampPublishListener, WampSubscribeListener or WampUnsubscribeListener) have to be authenticated.
AuthenticationSecretProvider	authenticationSecretProvider() Configures an implementation of the secret provider interface AuthenticationSecretProvider for authentication.
org.springframework.messaging.SubscribableChannel	brokerChannel() Channel from the application to the brokerMessageHandler()
Executor	brokerChannelExecutor() Executor used by the brokerChannel().
org.springframework.messaging.MessageHandler	brokerMessageHandler()
protected WampMessageSelector	brokerMessageHandlerMessageSelector()
org.springframework.messaging.SubscribableChannel	clientInboundChannel() Channel for inbound messages between WampSubProtocolHandler, brokerMessageHandler() and #annotationMethodMessageHandler()
Executor	clientInboundChannelExecutor()
org.springframework.messaging.SubscribableChannel	clientOutboundChannel() Channel for outbound messages sent back to WebSocket clients.
Executor	clientOutboundChannelExecutor()
protected void	configureClientInboundChannel(org.springframework.messaging.support.AbstractMessageChannel channel)
void	configureWebSocketTransport(WebSocketTransportRegistration registration) Configure options related to the processing of messages received from and sent to WebSocket clients.
org.springframework.core.convert.ConversionService	conversionService() Returns a ConversionService that is used for argument conversion
protected org.springframework.web.socket.WebSocketHandler	decorateWebSocketHandler(org.springframework.web.socket.WebSocketHandler handler)
EventMessenger	eventMessenger()
protected WebSocketTransportRegistration	getTransportRegistration()
org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler	messageBrokerSockJsTaskScheduler() The default TaskScheduler to use if none is configured via SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler) , i.e.
org.springframework.messaging.converter.MessageConverter	messageConverter()
protected WampMessageSelector	methodMessageHandlerMessageSelector()
protected MethodParameterConverter	methodParameterConverter()
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper() Returns a Jackson's ObjectMapper instance.
protected org.springframework.util.PathMatcher	pathMatcher() Returns an instance of a PathMatcher.
protected void	registerWampEndpoints(WampEndpointRegistry registry) Register WAMP endpoints mapping each to a specific URL and (optionally) enabling and configuring SockJS fallback options.
void	setConfigurers(List<WampConfigurer> configurers)
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
org.springframework.web.socket.WebSocketHandler	subProtocolWebSocketHandler()
SubscriptionRegistry	subscriptionRegistry()
org.springframework.web.servlet.HandlerMapping	wampWebSocketHandlerMapping()
static org.springframework.beans.factory.config.CustomScopeConfigurer	webSocketScopeConfigurer(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)

Methods inherited from class java.lang.Object

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

Field Detail

internalObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper internalObjectMapper

internalPathMatcher

protected org.springframework.util.PathMatcher internalPathMatcher

internalConversionService

protected org.springframework.core.convert.ConversionService internalConversionService

Constructor Detail

DefaultWampConfiguration

public DefaultWampConfiguration()

Method Detail

setConfigurers

@Autowired(required=false)
public void setConfigurers(List<WampConfigurer> configurers)

setObjectMapper

@Autowired(required=false)
public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

registerWampEndpoints

protected void registerWampEndpoints(WampEndpointRegistry registry)

Register WAMP endpoints mapping each to a specific URL and (optionally) enabling and configuring SockJS fallback options.

clientInboundChannel

@Bean
public org.springframework.messaging.SubscribableChannel clientInboundChannel()

Channel for inbound messages between WampSubProtocolHandler, brokerMessageHandler() and #annotationMethodMessageHandler()

configureClientInboundChannel

protected void configureClientInboundChannel(org.springframework.messaging.support.AbstractMessageChannel channel)

clientInboundChannelExecutor

@Bean
public Executor clientInboundChannelExecutor()

clientOutboundChannel

@Bean
public org.springframework.messaging.SubscribableChannel clientOutboundChannel()

Channel for outbound messages sent back to WebSocket clients.

messageConverter

@Bean
public org.springframework.messaging.converter.MessageConverter messageConverter()

clientOutboundChannelExecutor

@Bean
public Executor clientOutboundChannelExecutor()

brokerChannel

@Bean
public org.springframework.messaging.SubscribableChannel brokerChannel()

Channel from the application to the brokerMessageHandler()

brokerChannelExecutor

public Executor brokerChannelExecutor()

Executor used by the brokerChannel(). By default messages send through the brokerChannel are processed synchronously.

brokerMessageHandler

@Bean
public org.springframework.messaging.MessageHandler brokerMessageHandler()

subscriptionRegistry

@Bean
public SubscriptionRegistry subscriptionRegistry()

brokerMessageHandlerMessageSelector

protected WampMessageSelector brokerMessageHandlerMessageSelector()

annotationMethodMessageHandler

@Bean
public org.springframework.messaging.MessageHandler annotationMethodMessageHandler(org.springframework.context.ConfigurableApplicationContext configurableApplicationContext)

methodParameterConverter

protected MethodParameterConverter methodParameterConverter()

methodMessageHandlerMessageSelector

protected WampMessageSelector methodMessageHandlerMessageSelector()

addArgumentResolvers

public void addArgumentResolvers(List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver> argumentResolvers)

eventMessenger

@Bean
public EventMessenger eventMessenger()

pathMatcher

protected org.springframework.util.PathMatcher pathMatcher()

Returns an instance of a PathMatcher. Used by the messageHandlers for matching the topicURI to a destination

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper()

Returns a Jackson's ObjectMapper instance. This mapper is used for serializing and deserializing WAMP messages. When this method returns null the library tries to find an ObjectMapper bean in the current spring context. If no bean exists the library creates a new instance of ObjectMapper.

conversionService

public org.springframework.core.convert.ConversionService conversionService()

Returns a ConversionService that is used for argument conversion

authenticationSecretProvider

public AuthenticationSecretProvider authenticationSecretProvider()

Configures an implementation of the secret provider interface AuthenticationSecretProvider for authentication.

authenticationHandler

public AuthenticationHandler authenticationHandler()

Configures an implementation of the AuthenticationHandler interface. When authenticationSecretProvider() returns null this method returns null and creates no AuthenticationHandler

authenticationRequired

public boolean authenticationRequired()

When this method returns true, all calls to a wamp server endpoint (methods annotated with WampCallListener, WampPublishListener, WampSubscribeListener or WampUnsubscribeListener) have to be authenticated.

wampWebSocketHandlerMapping

@Bean
public org.springframework.web.servlet.HandlerMapping wampWebSocketHandlerMapping()

subProtocolWebSocketHandler

@Bean
public org.springframework.web.socket.WebSocketHandler subProtocolWebSocketHandler()

addHandshakeInterceptors

protected void addHandshakeInterceptors(List<org.springframework.web.socket.server.HandshakeInterceptor> handshakeInterceptors)

decorateWebSocketHandler

protected org.springframework.web.socket.WebSocketHandler decorateWebSocketHandler(org.springframework.web.socket.WebSocketHandler handler)

getTransportRegistration

protected final WebSocketTransportRegistration getTransportRegistration()

configureWebSocketTransport

public void configureWebSocketTransport(WebSocketTransportRegistration registration)

Configure options related to the processing of messages received from and sent to WebSocket clients.

messageBrokerSockJsTaskScheduler

@Bean
public org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler messageBrokerSockJsTaskScheduler()

The default TaskScheduler to use if none is configured via SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler) , i.e.

 @Configuration
 public class WampConfig extends DefaultWampConfiguration {

        public void registerWampEndpoints(WampEndpointRegistry registry) {
                registry.addEndpoint("/wamp").withSockJS().setTaskScheduler(myScheduler());
        }

        // ...
 }
 

webSocketScopeConfigurer

@Bean
public static org.springframework.beans.factory.config.CustomScopeConfigurer webSocketScopeConfigurer(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)