spring-framework / org.springframework.messaging.simp.config / AbstractMessageBrokerConfiguration

AbstractMessageBrokerConfiguration

abstract class AbstractMessageBrokerConfiguration : ApplicationContextAware

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

#clientInboundChannel() and #clientOutboundChannel() deliver messages to and from remote clients to several message handlers such as

while #brokerChannel() delivers messages from within the application to the the respective message handlers. #brokerMessagingTemplate() can be injected into any application component to send messages.

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

Author
Rossen Stoyanchev

Author
Brian Clozel

Since
4.0

Functions

brokerChannel

open fun brokerChannel(): AbstractSubscribableChannel

brokerChannelExecutor

open fun brokerChannelExecutor(): ThreadPoolTaskExecutor

brokerMessageConverter

open fun brokerMessageConverter(): CompositeMessageConverter

brokerMessagingTemplate

open fun brokerMessagingTemplate(): SimpMessagingTemplate

clientInboundChannel

open fun clientInboundChannel(): AbstractSubscribableChannel

clientInboundChannelExecutor

open fun clientInboundChannelExecutor(): ThreadPoolTaskExecutor

clientOutboundChannel

open fun clientOutboundChannel(): AbstractSubscribableChannel

clientOutboundChannelExecutor

open fun clientOutboundChannelExecutor(): ThreadPoolTaskExecutor

getApplicationContext

open fun getApplicationContext(): ApplicationContext

getPathMatcher

fun getPathMatcher(): PathMatcher

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

getValidator

open fun getValidator(): Validator

Override this method to provide a custom Validator.

messageBrokerTaskScheduler

open fun messageBrokerTaskScheduler(): ThreadPoolTaskScheduler

setApplicationContext

open fun setApplicationContext(applicationContext: ApplicationContext): Unit

simpAnnotationMethodMessageHandler

open fun simpAnnotationMethodMessageHandler(): SimpAnnotationMethodMessageHandler

simpleBrokerMessageHandler

open fun simpleBrokerMessageHandler(): AbstractBrokerMessageHandler

stompBrokerRelayMessageHandler

open fun stompBrokerRelayMessageHandler(): AbstractBrokerMessageHandler

userDestinationMessageHandler

open fun userDestinationMessageHandler(): UserDestinationMessageHandler

userDestinationResolver

open fun userDestinationResolver(): UserDestinationResolver

userRegistry

open fun userRegistry(): SimpUserRegistry

userRegistryMessageHandler

open fun userRegistryMessageHandler(): MessageHandler

Inheritors

WebSocketMessageBrokerConfigurationSupport

abstract class WebSocketMessageBrokerConfigurationSupport : AbstractMessageBrokerConfiguration

Extends AbstractMessageBrokerConfiguration and adds configuration for receiving and responding to STOMP messages from WebSocket clients.

Typically used in conjunction with EnableWebSocketMessageBroker but can also be extended directly.