org.springframework.web.socket.config

Class MessageBrokerBeanDefinitionParser

java.lang.Object

org.springframework.web.socket.config.MessageBrokerBeanDefinitionParser

All Implemented Interfaces:

BeanDefinitionParser

class MessageBrokerBeanDefinitionParser
extends java.lang.Object
implements BeanDefinitionParser

A BeanDefinitionParser that provides the configuration for the <websocket:message-broker/> XML namespace element.

Registers a Spring MVC HandlerMapping with order 1 to map HTTP WebSocket handshake requests from STOMP/WebSocket clients.

Registers the following MessageChannels:

• "clientInboundChannel" for receiving messages from clients (e.g. WebSocket clients)
• "clientOutboundChannel" for sending messages to clients (e.g. WebSocket clients)
• "brokerChannel" for sending messages from within the application to the message broker

Registers one of the following based on the selected message broker options:

• a SimpleBrokerMessageHandler if the is used
• a StompBrokerRelayMessageHandler if the is used

Registers a UserDestinationMessageHandler for handling user destinations.

Since:

4.0

Author:

Brian Clozel, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MessageBrokerBeanDefinitionParser.DecoratingFactoryBean

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_MAPPING_ORDER
private static boolean	jackson2Present
static java.lang.String	SCHEDULER_BEAN_NAME
static java.lang.String	SOCKJS_SCHEDULER_BEAN_NAME
static java.lang.String	WEB_SOCKET_HANDLER_BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
MessageBrokerBeanDefinitionParser()

Method Summary

Modifier and Type	Method and Description
private ManagedList<java.lang.Object>	extractBeanSubElements(org.w3c.dom.Element parentElement, ParserContext parserContext)
private RootBeanDefinition	getDefaultExecutorBeanDefinition(java.lang.String channelName)
private RuntimeBeanReference	getMessageChannel(java.lang.String name, org.w3c.dom.Element element, ParserContext context, java.lang.Object source)
BeanDefinition	parse(org.w3c.dom.Element element, ParserContext context) Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.
private void	registerAnnotationMethodMessageHandler(org.w3c.dom.Element messageBrokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference converter, RuntimeBeanReference messagingTemplate, ParserContext context, java.lang.Object source)
private static java.lang.String	registerBeanDef(RootBeanDefinition beanDef, ParserContext context, java.lang.Object source)
private static void	registerBeanDefByName(java.lang.String name, RootBeanDefinition beanDef, ParserContext context, java.lang.Object source)
private ManagedMap<java.lang.String,java.lang.Object>	registerHandlerMapping(org.w3c.dom.Element element, ParserContext context, java.lang.Object source)
private RootBeanDefinition	registerMessageBroker(org.w3c.dom.Element brokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference brokerChannel, java.lang.Object userDestHandler, RuntimeBeanReference brokerTemplate, RuntimeBeanReference userRegistry, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerMessageConverter(org.w3c.dom.Element element, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerMessagingTemplate(org.w3c.dom.Element element, RuntimeBeanReference brokerChannel, RuntimeBeanReference messageConverter, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerRequestHandler(org.w3c.dom.Element element, RuntimeBeanReference subProtoHandler, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerStompHandler(org.w3c.dom.Element element, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerUserDestHandler(org.w3c.dom.Element brokerElem, RuntimeBeanReference userRegistry, RuntimeBeanReference inChannel, RuntimeBeanReference brokerChannel, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerUserDestResolver(org.w3c.dom.Element brokerElem, RuntimeBeanReference userRegistry, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerUserRegistry(org.w3c.dom.Element element, ParserContext context, java.lang.Object source)
private RuntimeBeanReference	registerUserRegistryMessageHandler(RuntimeBeanReference userRegistry, RuntimeBeanReference brokerTemplate, java.lang.String destination, ParserContext context, java.lang.Object source)
private void	registerWebSocketMessageBrokerStats(RootBeanDefinition broker, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, java.lang.Object source)

Methods inherited from class java.lang.Object

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

Field Detail

WEB_SOCKET_HANDLER_BEAN_NAME

public static final java.lang.String WEB_SOCKET_HANDLER_BEAN_NAME

See Also:

Constant Field Values

SCHEDULER_BEAN_NAME

public static final java.lang.String SCHEDULER_BEAN_NAME

See Also:

Constant Field Values

SOCKJS_SCHEDULER_BEAN_NAME

public static final java.lang.String SOCKJS_SCHEDULER_BEAN_NAME

See Also:

Constant Field Values

DEFAULT_MAPPING_ORDER

private static final int DEFAULT_MAPPING_ORDER

See Also:

Constant Field Values

jackson2Present

private static final boolean jackson2Present

Constructor Detail

MessageBrokerBeanDefinitionParser

MessageBrokerBeanDefinitionParser()

Method Detail

parse

public BeanDefinition parse(org.w3c.dom.Element element,
                            ParserContext context)

Description copied from interface: BeanDefinitionParser

Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Implementations must return the primary BeanDefinition that results from the parse if they will ever be used in a nested fashion (for example as an inner tag in a <property/> tag). Implementations may return null if they will not be used in a nested fashion.

Specified by:

parse in interface BeanDefinitionParser

Parameters:

element - the element that is to be parsed into one or more BeanDefinitions

context - the object encapsulating the current state of the parsing process; provides access to a BeanDefinitionRegistry

Returns:

the primary BeanDefinition

registerUserRegistry

private RuntimeBeanReference registerUserRegistry(org.w3c.dom.Element element,
                                                  ParserContext context,
                                                  java.lang.Object source)

registerHandlerMapping

private ManagedMap<java.lang.String,java.lang.Object> registerHandlerMapping(org.w3c.dom.Element element,
                                                                             ParserContext context,
                                                                             java.lang.Object source)

getMessageChannel

private RuntimeBeanReference getMessageChannel(java.lang.String name,
                                               org.w3c.dom.Element element,
                                               ParserContext context,
                                               java.lang.Object source)

getDefaultExecutorBeanDefinition

private RootBeanDefinition getDefaultExecutorBeanDefinition(java.lang.String channelName)

registerStompHandler

private RuntimeBeanReference registerStompHandler(org.w3c.dom.Element element,
                                                  RuntimeBeanReference inChannel,
                                                  RuntimeBeanReference outChannel,
                                                  ParserContext context,
                                                  java.lang.Object source)

registerRequestHandler

private RuntimeBeanReference registerRequestHandler(org.w3c.dom.Element element,
                                                    RuntimeBeanReference subProtoHandler,
                                                    ParserContext context,
                                                    java.lang.Object source)

registerMessageBroker

private RootBeanDefinition registerMessageBroker(org.w3c.dom.Element brokerElement,
                                                 RuntimeBeanReference inChannel,
                                                 RuntimeBeanReference outChannel,
                                                 RuntimeBeanReference brokerChannel,
                                                 java.lang.Object userDestHandler,
                                                 RuntimeBeanReference brokerTemplate,
                                                 RuntimeBeanReference userRegistry,
                                                 ParserContext context,
                                                 java.lang.Object source)

registerUserRegistryMessageHandler

private RuntimeBeanReference registerUserRegistryMessageHandler(RuntimeBeanReference userRegistry,
                                                                RuntimeBeanReference brokerTemplate,
                                                                java.lang.String destination,
                                                                ParserContext context,
                                                                java.lang.Object source)

registerMessageConverter

private RuntimeBeanReference registerMessageConverter(org.w3c.dom.Element element,
                                                      ParserContext context,
                                                      java.lang.Object source)

registerMessagingTemplate

private RuntimeBeanReference registerMessagingTemplate(org.w3c.dom.Element element,
                                                       RuntimeBeanReference brokerChannel,
                                                       RuntimeBeanReference messageConverter,
                                                       ParserContext context,
                                                       java.lang.Object source)

registerAnnotationMethodMessageHandler

private void registerAnnotationMethodMessageHandler(org.w3c.dom.Element messageBrokerElement,
                                                    RuntimeBeanReference inChannel,
                                                    RuntimeBeanReference outChannel,
                                                    RuntimeBeanReference converter,
                                                    RuntimeBeanReference messagingTemplate,
                                                    ParserContext context,
                                                    java.lang.Object source)

extractBeanSubElements

private ManagedList<java.lang.Object> extractBeanSubElements(org.w3c.dom.Element parentElement,
                                                             ParserContext parserContext)

registerUserDestResolver

private RuntimeBeanReference registerUserDestResolver(org.w3c.dom.Element brokerElem,
                                                      RuntimeBeanReference userRegistry,
                                                      ParserContext context,
                                                      java.lang.Object source)

registerUserDestHandler

private RuntimeBeanReference registerUserDestHandler(org.w3c.dom.Element brokerElem,
                                                     RuntimeBeanReference userRegistry,
                                                     RuntimeBeanReference inChannel,
                                                     RuntimeBeanReference brokerChannel,
                                                     ParserContext context,
                                                     java.lang.Object source)

registerWebSocketMessageBrokerStats

private void registerWebSocketMessageBrokerStats(RootBeanDefinition broker,
                                                 RuntimeBeanReference inChannel,
                                                 RuntimeBeanReference outChannel,
                                                 ParserContext context,
                                                 java.lang.Object source)

registerBeanDef

private static java.lang.String registerBeanDef(RootBeanDefinition beanDef,
                                                ParserContext context,
                                                java.lang.Object source)

registerBeanDefByName

private static void registerBeanDefByName(java.lang.String name,
                                          RootBeanDefinition beanDef,
                                          ParserContext context,
                                          java.lang.Object source)