ch.rasc.wampspring.config

Class WampConfigurerAdapter

java.lang.Object

ch.rasc.wampspring.config.WampConfigurerAdapter

All Implemented Interfaces:

WampConfigurer

public class WampConfigurerAdapter
extends Object
implements WampConfigurer

Defines the default implementation of the WampConfigurer interface. A @Configuration class can implement the WampConfigurer interface or subclass this class.

Constructor Summary

Constructors

Constructor and Description
WampConfigurerAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WampConfigurerAdapter

public WampConfigurerAdapter()

Method Detail

outboundExecutor

public Executor outboundExecutor()

Description copied from interface: WampConfigurer

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

Specified by:

outboundExecutor in interface WampConfigurer

wampEndpointPath

public String wampEndpointPath()

Description copied from interface: WampConfigurer

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

Specified by:

wampEndpointPath in interface WampConfigurer

objectMapper

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

Description copied from interface: WampConfigurer

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

Specified by:

objectMapper in interface WampConfigurer

conversionService

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

Description copied from interface: WampConfigurer

Configures a ConversionService that is used by the WampMessageBodyMethodArgumentResolver

Specified by:

conversionService in interface WampConfigurer

configureWampWebsocketHandler

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

Description copied from interface: WampConfigurer

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

Specified by:

configureWampWebsocketHandler in interface WampConfigurer

authenticationSecretProvider

public AuthenticationSecretProvider authenticationSecretProvider()

Description copied from interface: WampConfigurer

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.

Specified by:

authenticationSecretProvider in interface WampConfigurer

authenticationHandler

public AuthenticationHandler authenticationHandler()

Description copied from interface: WampConfigurer

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

Specified by:

authenticationHandler in interface WampConfigurer

authenticationRequired

public boolean authenticationRequired()

Description copied from interface: WampConfigurer

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

Specified by:

authenticationRequired in interface WampConfigurer