A org.springframework.beans.factory.xml.BeanDefinitionParser that provides the configuration for the <websocket:message-broker/> XML namespace element.

Registers a Spring MVC org.springframework.web.servlet.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 <simple-broker/> is used
a StompBrokerRelayMessageHandler if the <stomp-broker-relay/> is used

Registers a UserDestinationMessageHandler for handling user destinations.

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private static final int	DEFAULT_MAPPING_ORDER
private static final boolean	gsonPresent
private static final boolean	jackson2Present
private static final boolean	javaxValidationPresent
private static final boolean	jsonbPresent
public static final String	MESSAGE_CONVERTER_BEAN_NAME
public static final String	MESSAGING_TEMPLATE_BEAN_NAME
public static final String	SCHEDULER_BEAN_NAME
public static final String	SOCKJS_SCHEDULER_BEAN_NAME
public static final String	WEB_SOCKET_HANDLER_BEAN_NAME

Access	Constructor and Description
pack-priv	MessageBrokerBeanDefinitionParser()

Method Summary

Modifier and Type	Method and Description
private ManagedList<Object>	extractBeanSubElements(Element parentElement, ParserContext context)
private RootBeanDefinition	getDefaultExecutorBeanDefinition(String channelName)
private RuntimeBeanReference	getMessageChannel(String name, Element element, ParserContext context, Object source)
private RuntimeBeanReference	getValidator(Element messageBrokerElement, Object source, ParserContext context)
public BeanDefinition	parse(Element the element that is to be parsed into one or more `BeanDefinitions` element, ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` context) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Parse the specified `Element` and register the resulting `BeanDefinition(s)` with the `BeanDefinitionRegistry` embedded in the supplied `ParserContext`.
private void	registerAnnotationMethodMessageHandler(Element messageBrokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference converter, RuntimeBeanReference messagingTemplate, ParserContext context, Object source)
private static String	registerBeanDef(RootBeanDefinition beanDef, ParserContext context, Object source)
private static void	registerBeanDefByName(String name, RootBeanDefinition beanDef, ParserContext context, Object source)
private ManagedMap<String, Object>	registerHandlerMapping(Element element, ParserContext context, Object source)
private RootBeanDefinition	registerMessageBroker(Element brokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference brokerChannel, Object userDestHandler, RuntimeBeanReference brokerTemplate, RuntimeBeanReference userRegistry, ParserContext context, Object source)
private RuntimeBeanReference	registerMessageConverter(Element element, ParserContext context, Object source)
private RuntimeBeanReference	registerMessagingTemplate(Element element, RuntimeBeanReference brokerChannel, RuntimeBeanReference messageConverter, ParserContext context, Object source)
private RuntimeBeanReference	registerRequestHandler(Element element, RuntimeBeanReference subProtoHandler, ParserContext ctx, Object source)
private RuntimeBeanReference	registerStompHandler(Element element, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, Object source)
private RuntimeBeanReference	registerUserDestHandler(Element brokerElem, RuntimeBeanReference userRegistry, RuntimeBeanReference inChannel, RuntimeBeanReference brokerChannel, ParserContext context, Object source)
private RuntimeBeanReference	registerUserDestResolver(Element brokerElem, RuntimeBeanReference userRegistry, ParserContext context, Object source)
private RuntimeBeanReference	registerUserRegistry(Element element, ParserContext context, Object source)
private RuntimeBeanReference	registerUserRegistryMessageHandler(RuntimeBeanReference userRegistry, RuntimeBeanReference brokerTemplate, String destination, ParserContext context, Object source)
private void	registerWebSocketMessageBrokerStats(RootBeanDefinition broker, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, Object source)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_MAPPING_ORDER	back to summary
private static final int DEFAULT_MAPPING_ORDER

gsonPresent	back to summary
private static final boolean gsonPresent

jackson2Present	back to summary
private static final boolean jackson2Present

javaxValidationPresent	back to summary
private static final boolean javaxValidationPresent

jsonbPresent	back to summary
private static final boolean jsonbPresent

MESSAGE_CONVERTER_BEAN_NAME	back to summary
public static final String MESSAGE_CONVERTER_BEAN_NAME

MESSAGING_TEMPLATE_BEAN_NAME	back to summary
public static final String MESSAGING_TEMPLATE_BEAN_NAME

SCHEDULER_BEAN_NAME	back to summary
public static final String SCHEDULER_BEAN_NAME

SOCKJS_SCHEDULER_BEAN_NAME	back to summary
public static final String SOCKJS_SCHEDULER_BEAN_NAME

WEB_SOCKET_HANDLER_BEAN_NAME	back to summary
public static final String WEB_SOCKET_HANDLER_BEAN_NAME

MessageBrokerBeanDefinitionParser	back to summary
pack-priv MessageBrokerBeanDefinitionParser()

Method Detail

extractBeanSubElements	back to summary
private ManagedList<Object> extractBeanSubElements(Element parentElement, ParserContext context)

getDefaultExecutorBeanDefinition	back to summary
private RootBeanDefinition getDefaultExecutorBeanDefinition(String channelName) Annotations @Nullable

getMessageChannel	back to summary
private RuntimeBeanReference getMessageChannel(String name, Element element, ParserContext context, Object source)

getValidator	back to summary
private RuntimeBeanReference getValidator(Element messageBrokerElement, Object source, ParserContext context) Annotations @Nullable

parse back to summary

parse	back to summary
public BeanDefinition parse(Element element, ParserContext context) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse. 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. Parameters element:Element the element that is to be parsed into one or more `BeanDefinitions` context:ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` Returns:BeanDefinition the primary `BeanDefinition` Annotations @Override

public BeanDefinition parse(Element element, ParserContext context)

Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

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.

Parameters

element:Element: the element that is to be parsed into one or more BeanDefinitions
context:ParserContext: the object encapsulating the current state of the parsing process; provides access to a org.springframework.beans.factory.support.BeanDefinitionRegistry

Returns:BeanDefinition

the primary BeanDefinition

Annotations

@Override

registerAnnotationMethodMessageHandler	back to summary
private void registerAnnotationMethodMessageHandler(Element messageBrokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference converter, RuntimeBeanReference messagingTemplate, ParserContext context, Object source)

registerBeanDef	back to summary
private static String registerBeanDef(RootBeanDefinition beanDef, ParserContext context, Object source)

registerBeanDefByName	back to summary
private static void registerBeanDefByName(String name, RootBeanDefinition beanDef, ParserContext context, Object source)

registerHandlerMapping	back to summary
private ManagedMap<String, Object> registerHandlerMapping(Element element, ParserContext context, Object source)

registerMessageBroker	back to summary
private RootBeanDefinition registerMessageBroker(Element brokerElement, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, RuntimeBeanReference brokerChannel, Object userDestHandler, RuntimeBeanReference brokerTemplate, RuntimeBeanReference userRegistry, ParserContext context, Object source)

registerMessageConverter	back to summary
private RuntimeBeanReference registerMessageConverter(Element element, ParserContext context, Object source)

registerMessagingTemplate	back to summary
private RuntimeBeanReference registerMessagingTemplate(Element element, RuntimeBeanReference brokerChannel, RuntimeBeanReference messageConverter, ParserContext context, Object source)

registerRequestHandler	back to summary
private RuntimeBeanReference registerRequestHandler(Element element, RuntimeBeanReference subProtoHandler, ParserContext ctx, Object source)

registerStompHandler	back to summary
private RuntimeBeanReference registerStompHandler(Element element, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, Object source)

registerUserDestHandler	back to summary
private RuntimeBeanReference registerUserDestHandler(Element brokerElem, RuntimeBeanReference userRegistry, RuntimeBeanReference inChannel, RuntimeBeanReference brokerChannel, ParserContext context, Object source)

registerUserDestResolver	back to summary
private RuntimeBeanReference registerUserDestResolver(Element brokerElem, RuntimeBeanReference userRegistry, ParserContext context, Object source)

registerUserRegistry	back to summary
private RuntimeBeanReference registerUserRegistry(Element element, ParserContext context, Object source)

registerUserRegistryMessageHandler	back to summary
private RuntimeBeanReference registerUserRegistryMessageHandler(RuntimeBeanReference userRegistry, RuntimeBeanReference brokerTemplate, String destination, ParserContext context, Object source)

registerWebSocketMessageBrokerStats	back to summary
private void registerWebSocketMessageBrokerStats(RootBeanDefinition broker, RuntimeBeanReference inChannel, RuntimeBeanReference outChannel, ParserContext context, Object source)

org.springframework.web.socket.config back to summary

private final Class MessageBrokerBeanDefinitionParser.DecoratingFactoryBean

Class Inheritance

extends Object
implements FactoryBean<WebSocketHandler>

java.lang.Object
org.springframework.web.socket.config.MessageBrokerBeanDefinitionParser.DecoratingFactoryBean

All Implemented Interfaces

org.springframework.beans.factory.FactoryBean

Field Summary

Modifier and Type	Field and Description
private final List<WebSocketHandlerDecoratorFactory>	factories
private final WebSocketHandler	handler

Constructor Summary

Access	Constructor and Description
public	DecoratingFactoryBean(WebSocketHandler handler, List<WebSocketHandlerDecoratorFactory> factories)

Method Summary

Modifier and Type	Method and Description
public WebSocketHandler	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<?>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

factories	back to summary
private final List<WebSocketHandlerDecoratorFactory> factories

handler	back to summary
private final WebSocketHandler handler

Constructor Detail

DecoratingFactoryBean	back to summary
public DecoratingFactoryBean(WebSocketHandler handler, List<WebSocketHandlerDecoratorFactory> factories) Annotations @SuppressWarnings:unused

Method Detail

getObject back to summary

getObject	back to summary
public WebSocketHandler getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:WebSocketHandler an instance of the bean (can be `null`) Annotations @Override

public WebSocketHandler getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:WebSocketHandler

an instance of the bean (can be null)

Annotations

@Override

getObjectType back to summary

getObjectType	back to summary
public Class<?> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<?> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<?> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<?>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

pack-priv Class MessageBrokerBeanDefinitionParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class MessageBrokerBeanDefinitionParser.DecoratingFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail