ch.rasc.wampspring.config

Interface WampConfigurer

All Known Implementing Classes:

WampConfigurerAdapter

public interface WampConfigurer

Defines callback methods to configure the WAMP support via EnableWamp

Method Summary

Modifier and Type	Method and Description
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.
void	configureWampWebsocketHandler(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration reg) Doing some additional configuration of the WampWebsocketHandler registration.
org.springframework.core.convert.ConversionService	conversionService() Configures a ConversionService that is used by the WampMessageBodyMethodArgumentResolver
com.fasterxml.jackson.databind.ObjectMapper	objectMapper() Configures Jackson's ObjectMapper instance.
Executor	outboundExecutor() Configures an Executor which is used for sending outbound WAMP messages.
String	wampEndpointPath() Configures the endpoint path where the WebSocket WAMP handler is listening for requests.

Method Detail

outboundExecutor

Executor outboundExecutor()

Configures an Executor which is used for sending outbound WAMP messages.

wampEndpointPath

String wampEndpointPath()

Configures the endpoint path where the WebSocket WAMP handler is listening for requests. This path must start with an / character.

objectMapper

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

Configures Jackson's ObjectMapper instance. This mapper is used for serializing and deserializing wamp messages.

conversionService

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

Configures a ConversionService that is used by the WampMessageBodyMethodArgumentResolver

configureWampWebsocketHandler

void configureWampWebsocketHandler(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration reg)

Doing some additional configuration of the WampWebsocketHandler registration. For example reg.withSockJS() turns SockJS support on.

authenticationSecretProvider

AuthenticationSecretProvider authenticationSecretProvider()

Configures an implementation of the secret provider interface AuthenticationSecretProvider for authentication. If not configured the library creates and uses an instance of the class NoOpAuthenticationSecretProvider.

authenticationHandler

AuthenticationHandler authenticationHandler()

Configures an implementation of the AuthenticationHandler interface. If not configured the library creates and uses an instance of the class DefaultAuthenticationHandler.

authenticationRequired

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.