Class AbstractMessageBrokerConfiguration

java.lang.Object

org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public abstract class AbstractMessageBrokerConfiguration
extends Object
implements org.springframework.context.ApplicationContextAware

Provides essential configuration for handling messages with simple messaging protocols such as STOMP.

clientInboundChannel(Executor) and clientOutboundChannel(Executor) deliver messages to and from remote clients to several message handlers such as the following.

• simpAnnotationMethodMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, SimpMessagingTemplate, CompositeMessageConverter)
• simpleBrokerMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationResolver)
• stompBrokerRelayMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationMessageHandler, MessageHandler, UserDestinationResolver)
• userDestinationMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationResolver)

brokerChannel(AbstractSubscribableChannel, AbstractSubscribableChannel, Executor) delivers messages from within the application to the respective message handlers. brokerMessagingTemplate(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, CompositeMessageConverter) can be injected into any application component to send messages.

Subclasses are responsible for the parts of the configuration that feed messages to and from the client inbound/outbound channels (for example, STOMP over WebSocket).

Since:

4.0

Author:

Rossen Stoyanchev, Brian Clozel, Sebastien Deleuze

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessageBrokerConfiguration()	Protected constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
protected void	addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
AbstractSubscribableChannel	brokerChannel(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, Executor executor)
Executor	brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
CompositeMessageConverter	brokerMessageConverter()
SimpMessagingTemplate	brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, CompositeMessageConverter brokerMessageConverter)
AbstractSubscribableChannel	clientInboundChannel(Executor executor)
Executor	clientInboundChannelExecutor()
AbstractSubscribableChannel	clientOutboundChannel(Executor executor)
Executor	clientOutboundChannelExecutor()
protected void	configureClientInboundChannel(ChannelRegistration registration)	A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.
protected void	configureClientOutboundChannel(ChannelRegistration registration)	A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.
protected void	configureMessageBroker(MessageBrokerRegistry registry)	A hook for subclasses to customize message broker configuration through the provided MessageBrokerRegistry instance.
protected boolean	configureMessageConverters(List<MessageConverter> messageConverters)	Override this method to add custom message converters.
protected SimpAnnotationMethodMessageHandler	createAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate)	Protected method for plugging in a custom subclass of SimpAnnotationMethodMessageHandler.
protected MappingJackson2MessageConverter	createJacksonConverter()	Allow to customize Jackson 2.x JSON converter.
protected JacksonJsonMessageConverter	createJacksonJsonConverter()	Allow to customize Jackson 3.x JSON converter.
protected abstract SimpUserRegistry	createLocalUserRegistry(@Nullable Integer order)	Create the user registry that provides access to local users.
@Nullable org.springframework.context.ApplicationContext	getApplicationContext()
protected final MessageBrokerRegistry	getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)	An accessor for the MessageBrokerRegistry that ensures its one-time creation and initialization through configureMessageBroker(MessageBrokerRegistry).
protected final ChannelRegistration	getClientInboundChannelRegistration()
protected final ChannelRegistration	getClientOutboundChannelRegistration()
final @Nullable org.springframework.util.PathMatcher	getPathMatcher(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)	Provide access to the configured PatchMatcher for access from other configuration classes.
protected final int	getPhase()
@Nullable org.springframework.validation.Validator	getValidator()	Override this method to provide a custom Validator.
protected int	initPhase()
org.springframework.scheduling.TaskScheduler	messageBrokerTaskScheduler()
void	setApplicationContext(@Nullable org.springframework.context.ApplicationContext applicationContext)
SimpAnnotationMethodMessageHandler	simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate, CompositeMessageConverter brokerMessageConverter)
@Nullable AbstractBrokerMessageHandler	simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)
protected org.springframework.validation.Validator	simpValidator()	Return an Validator instance for validating @Payload method arguments.
@Nullable AbstractBrokerMessageHandler	stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, @Nullable MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver)
UserDestinationMessageHandler	userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)
UserDestinationResolver	userDestinationResolver(SimpUserRegistry userRegistry, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
SimpUserRegistry	userRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
@Nullable MessageHandler	userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, org.springframework.scheduling.TaskScheduler scheduler)

Methods inherited from class Object

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

Constructor Details

AbstractMessageBrokerConfiguration

protected AbstractMessageBrokerConfiguration()

Protected constructor.

Method Details

setApplicationContext

public void setApplicationContext(@Nullable org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getApplicationContext

public @Nullable org.springframework.context.ApplicationContext getApplicationContext()

clientInboundChannel

@Bean
public AbstractSubscribableChannel clientInboundChannel(@Qualifier("clientInboundChannelExecutor")
 Executor executor)

clientInboundChannelExecutor

@Bean
public Executor clientInboundChannelExecutor()

getClientInboundChannelRegistration

protected final ChannelRegistration getClientInboundChannelRegistration()

getPhase

protected final int getPhase()

initPhase

protected int initPhase()

configureClientInboundChannel

protected void configureClientInboundChannel(ChannelRegistration registration)

A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.

clientOutboundChannel

@Bean
public AbstractSubscribableChannel clientOutboundChannel(@Qualifier("clientOutboundChannelExecutor")
 Executor executor)

clientOutboundChannelExecutor

@Bean
public Executor clientOutboundChannelExecutor()

getClientOutboundChannelRegistration

protected final ChannelRegistration getClientOutboundChannelRegistration()

configureClientOutboundChannel

protected void configureClientOutboundChannel(ChannelRegistration registration)

A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.

brokerChannel

@Bean
public AbstractSubscribableChannel brokerChannel(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 @Qualifier("brokerChannelExecutor")
 Executor executor)

brokerChannelExecutor

@Bean
public Executor brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

getBrokerRegistry

protected final MessageBrokerRegistry getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

An accessor for the MessageBrokerRegistry that ensures its one-time creation and initialization through configureMessageBroker(MessageBrokerRegistry).

configureMessageBroker

protected void configureMessageBroker(MessageBrokerRegistry registry)

A hook for subclasses to customize message broker configuration through the provided MessageBrokerRegistry instance.

getPathMatcher

public final @Nullable org.springframework.util.PathMatcher getPathMatcher(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

Provide access to the configured PatchMatcher for access from other configuration classes.

simpAnnotationMethodMessageHandler

@Bean
public SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 SimpMessagingTemplate brokerMessagingTemplate,
 CompositeMessageConverter brokerMessageConverter)

createAnnotationMethodMessageHandler

protected SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 SimpMessagingTemplate brokerMessagingTemplate)

Protected method for plugging in a custom subclass of SimpAnnotationMethodMessageHandler.

Since:

5.3.2

addArgumentResolvers

protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)

addReturnValueHandlers

protected void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)

simpleBrokerMessageHandler

@Bean
public @Nullable AbstractBrokerMessageHandler simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 AbstractSubscribableChannel brokerChannel,
 UserDestinationResolver userDestinationResolver)

stompBrokerRelayMessageHandler

@Bean
public @Nullable AbstractBrokerMessageHandler stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 AbstractSubscribableChannel brokerChannel,
 UserDestinationMessageHandler userDestinationMessageHandler,
 @Nullable MessageHandler userRegistryMessageHandler,
 UserDestinationResolver userDestinationResolver)

userDestinationMessageHandler

@Bean
public UserDestinationMessageHandler userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 AbstractSubscribableChannel brokerChannel,
 UserDestinationResolver userDestinationResolver)

userRegistryMessageHandler

@Bean
public @Nullable MessageHandler userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 SimpUserRegistry userRegistry,
 SimpMessagingTemplate brokerMessagingTemplate,
 @Qualifier("messageBrokerTaskScheduler")
 org.springframework.scheduling.TaskScheduler scheduler)

messageBrokerTaskScheduler

@Bean(name={"messageBrokerTaskScheduler","messageBrokerSockJsTaskScheduler"})
public org.springframework.scheduling.TaskScheduler messageBrokerTaskScheduler()

brokerMessagingTemplate

@Bean
public SimpMessagingTemplate brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel,
 AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel,
 CompositeMessageConverter brokerMessageConverter)

brokerMessageConverter

@Bean
public CompositeMessageConverter brokerMessageConverter()

createJacksonJsonConverter

protected JacksonJsonMessageConverter createJacksonJsonConverter()

Allow to customize Jackson 3.x JSON converter.

createJacksonConverter

protected MappingJackson2MessageConverter createJacksonConverter()

Allow to customize Jackson 2.x JSON converter.

configureMessageConverters

protected boolean configureMessageConverters(List<MessageConverter> messageConverters)

Override this method to add custom message converters.

Parameters:

messageConverters - the list to add converters to, initially empty

Returns:

true if default message converters should be added to list, false if no more converters should be added

userDestinationResolver

@Bean
public UserDestinationResolver userDestinationResolver(SimpUserRegistry userRegistry,
 AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

userRegistry

@Bean
public SimpUserRegistry userRegistry(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

createLocalUserRegistry

protected abstract SimpUserRegistry createLocalUserRegistry(@Nullable Integer order)

Create the user registry that provides access to local users.

Parameters:

order - the order to use as a SmartApplicationListener.

Since:

5.1

simpValidator

protected org.springframework.validation.Validator simpValidator()

Return an Validator instance for validating @Payload method arguments.

In order, this method tries to get a Validator instance:

• delegating to getValidator() first
• if none returned, getting an existing instance with its well-known name "mvcValidator", created by an MVC configuration
• if none returned, checking the classpath for the presence of a JSR-303 implementation before creating a OptionalValidatorFactoryBean
• returning a no-op Validator instance

getValidator

public @Nullable org.springframework.validation.Validator getValidator()

Override this method to provide a custom Validator.

Since:

4.0.1