Spring Framework 6.1.4 · org.springframework.messaging.simp.config.MessageBrokerRegistry

Modifier and Type	Field and Description
private String[]	applicationDestinationPrefixes
private final ChannelRegistration	brokerChannelRegistration
private StompBrokerRelayRegistration	brokerRelayRegistration
private Integer	cacheLimit
private final SubscribableChannel	clientInboundChannel
private final MessageChannel	clientOutboundChannel
private PathMatcher	pathMatcher
private boolean	preservePublishOrder
private SimpleBrokerRegistration	simpleBrokerRegistration
private String	userDestinationPrefix
private Integer	userRegistryOrder

Access	Constructor and Description
public	MessageBrokerRegistry(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel)

Method Summary

Modifier and Type	Method and Description
public ChannelRegistration	configureBrokerChannel() Customize the channel used to send messages from the application to the message broker.
public SimpleBrokerRegistration	enableSimpleBroker(String... destinationPrefixes) Enable a simple message broker and configure one or more prefixes to filter destinations targeting the broker (e.g. destinations prefixed with "/topic").
public StompBrokerRelayRegistration	enableStompBrokerRelay(String... destinationPrefixes) Enable a STOMP broker relay and configure the destination prefixes supported by the message broker.
protected Collection<String>	getApplicationDestinationPrefixes()
protected ChannelRegistration	getBrokerChannelRegistration()
protected PathMatcher	getPathMatcher()
protected SimpleBrokerMessageHandler	getSimpleBroker(SubscribableChannel brokerChannel)
protected StompBrokerRelayMessageHandler	getStompBrokerRelay(SubscribableChannel brokerChannel)
protected String	getUserDestinationBroadcast()
protected String	getUserDestinationPrefix()
protected String	getUserRegistryBroadcast()
protected Integer	getUserRegistryOrder()
public MessageBrokerRegistry	setApplicationDestinationPrefixes(String... prefixes) Configure one or more prefixes to filter destinations targeting application annotated methods.
public MessageBrokerRegistry	setCacheLimit(int cacheLimit) Configure the cache limit to apply for registrations with the broker.
public MessageBrokerRegistry	setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use to match the destinations of incoming messages to `@MessageMapping` and `@SubscribeMapping` methods.
public MessageBrokerRegistry	setPreservePublishOrder(boolean preservePublishOrder) Whether the client must receive messages in the order of publication.
public MessageBrokerRegistry	setUserDestinationPrefix(String destinationPrefix) Configure the prefix used to identify user destinations.
public void	setUserRegistryOrder(int the order value order) Set the order for the `SimpUserRegistry` to use as a `SmartApplicationListener`.

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

applicationDestinationPrefixes	back to summary
private String[] applicationDestinationPrefixes Annotations @Nullable

brokerChannelRegistration	back to summary
private final ChannelRegistration brokerChannelRegistration

brokerRelayRegistration	back to summary
private StompBrokerRelayRegistration brokerRelayRegistration Annotations @Nullable

cacheLimit	back to summary
private Integer cacheLimit Annotations @Nullable

clientInboundChannel	back to summary
private final SubscribableChannel clientInboundChannel

clientOutboundChannel	back to summary
private final MessageChannel clientOutboundChannel

pathMatcher	back to summary
private PathMatcher pathMatcher Annotations @Nullable

preservePublishOrder	back to summary
private boolean preservePublishOrder

simpleBrokerRegistration	back to summary
private SimpleBrokerRegistration simpleBrokerRegistration Annotations @Nullable

userDestinationPrefix	back to summary
private String userDestinationPrefix Annotations @Nullable

userRegistryOrder	back to summary
private Integer userRegistryOrder Annotations @Nullable

MessageBrokerRegistry	back to summary
public MessageBrokerRegistry(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel)

Method Detail

configureBrokerChannel	back to summary
public ChannelRegistration configureBrokerChannel() Customize the channel used to send messages from the application to the message broker. By default, messages from the application to the message broker are sent synchronously, which means application code sending a message will find out if the message cannot be sent through an exception. However, this can be changed if the broker channel is configured here with task executor properties.

configureBrokerChannel

back to summary

public ChannelRegistration configureBrokerChannel()

Customize the channel used to send messages from the application to the message broker. By default, messages from the application to the message broker are sent synchronously, which means application code sending a message will find out if the message cannot be sent through an exception. However, this can be changed if the broker channel is configured here with task executor properties.

enableSimpleBroker	back to summary
public SimpleBrokerRegistration enableSimpleBroker(String... destinationPrefixes) Enable a simple message broker and configure one or more prefixes to filter destinations targeting the broker (e.g. destinations prefixed with "/topic").

enableStompBrokerRelay	back to summary
public StompBrokerRelayRegistration enableStompBrokerRelay(String... destinationPrefixes) Enable a STOMP broker relay and configure the destination prefixes supported by the message broker. Check the STOMP documentation of the message broker for supported destinations.

getApplicationDestinationPrefixes	back to summary
protected Collection<String> getApplicationDestinationPrefixes() Annotations @Nullable

getBrokerChannelRegistration	back to summary
protected ChannelRegistration getBrokerChannelRegistration()

getPathMatcher	back to summary
protected PathMatcher getPathMatcher() Annotations @Nullable

getSimpleBroker	back to summary
protected SimpleBrokerMessageHandler getSimpleBroker(SubscribableChannel brokerChannel) Annotations @Nullable

getStompBrokerRelay	back to summary
protected StompBrokerRelayMessageHandler getStompBrokerRelay(SubscribableChannel brokerChannel) Annotations @Nullable

getUserDestinationBroadcast	back to summary
protected String getUserDestinationBroadcast() Annotations @Nullable

getUserDestinationPrefix	back to summary
protected String getUserDestinationPrefix() Annotations @Nullable

getUserRegistryBroadcast	back to summary
protected String getUserRegistryBroadcast() Annotations @Nullable

getUserRegistryOrder	back to summary
protected Integer getUserRegistryOrder() Annotations @Nullable

setApplicationDestinationPrefixes	back to summary
public MessageBrokerRegistry setApplicationDestinationPrefixes(String... prefixes) Configure one or more prefixes to filter destinations targeting application annotated methods. For example destinations prefixed with "/app" may be processed by annotated methods while other destinations may target the message broker (e.g. "/topic", "/queue"). When messages are processed, the matching prefix is removed from the destination in order to form the lookup path. This means annotations should not contain the destination prefix. Prefixes that do not have a trailing slash will have one automatically appended.

setApplicationDestinationPrefixes

back to summary

public MessageBrokerRegistry setApplicationDestinationPrefixes(String... prefixes)

Configure one or more prefixes to filter destinations targeting application annotated methods. For example destinations prefixed with "/app" may be processed by annotated methods while other destinations may target the message broker (e.g. "/topic", "/queue").

When messages are processed, the matching prefix is removed from the destination in order to form the lookup path. This means annotations should not contain the destination prefix.

Prefixes that do not have a trailing slash will have one automatically appended.

setCacheLimit back to summary

setCacheLimit	back to summary
public MessageBrokerRegistry setCacheLimit(int cacheLimit) Configure the cache limit to apply for registrations with the broker. This is currently only applied for the destination cache in the subscription registry. The default cache limit there is 1024. Since 4.3.2 See Also `org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry#setCacheLimit`

public MessageBrokerRegistry setCacheLimit(int cacheLimit)

Configure the cache limit to apply for registrations with the broker.

This is currently only applied for the destination cache in the subscription registry. The default cache limit there is 1024.

Since: 4.3.2
See Also: org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry#setCacheLimit

setPathMatcher back to summary

setPathMatcher	back to summary
public MessageBrokerRegistry setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use to match the destinations of incoming messages to `@MessageMapping` and `@SubscribeMapping` methods. By default `org.springframework.util.AntPathMatcher` is configured. However applications may provide an `AntPathMatcher` instance customized to use "." (commonly used in messaging) instead of "/" as path separator or provide a completely different PathMatcher implementation. Note that the configured PathMatcher is only used for matching the portion of the destination after the configured prefix. For example given application destination prefix "/app" and destination "/app/price.stock.", the message might be mapped to a controller with "price" and "stock." as its type and method-level mappings respectively. When the simple broker is enabled, the PathMatcher configured here is also used to match message destinations when brokering messages. Since 4.1 See Also `org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry#setPathMatcher`

public MessageBrokerRegistry setPathMatcher(PathMatcher pathMatcher)

Configure the PathMatcher to use to match the destinations of incoming messages to @MessageMapping and @SubscribeMapping methods.

By default org.springframework.util.AntPathMatcher is configured. However applications may provide an AntPathMatcher instance customized to use "." (commonly used in messaging) instead of "/" as path separator or provide a completely different PathMatcher implementation.

Note that the configured PathMatcher is only used for matching the portion of the destination after the configured prefix. For example given application destination prefix "/app" and destination "/app/price.stock.**", the message might be mapped to a controller with "price" and "stock.**" as its type and method-level mappings respectively.

When the simple broker is enabled, the PathMatcher configured here is also used to match message destinations when brokering messages.

Since: 4.1
See Also: org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry#setPathMatcher

setPreservePublishOrder back to summary

setPreservePublishOrder	back to summary
public MessageBrokerRegistry setPreservePublishOrder(boolean preservePublishOrder) Whether the client must receive messages in the order of publication. By default messages sent to the `"clientOutboundChannel"` may not be processed in the same order because the channel is backed by a ThreadPoolExecutor that in turn does not guarantee processing in order. When this flag is set to `true` messages within the same session will be sent to the `"clientOutboundChannel"` one at a time in order to preserve the order of publication. Since 5.1

public MessageBrokerRegistry setPreservePublishOrder(boolean preservePublishOrder)

Whether the client must receive messages in the order of publication.

By default messages sent to the "clientOutboundChannel" may not be processed in the same order because the channel is backed by a ThreadPoolExecutor that in turn does not guarantee processing in order.

When this flag is set to true messages within the same session will be sent to the "clientOutboundChannel" one at a time in order to preserve the order of publication.

Since: 5.1

setUserDestinationPrefix	back to summary
public MessageBrokerRegistry setUserDestinationPrefix(String destinationPrefix) Configure the prefix used to identify user destinations. User destinations provide the ability for a user to subscribe to queue names unique to their session as well as for others to send messages to those unique, user-specific queues. For example when a user attempts to subscribe to "/user/queue/position-updates", the destination may be translated to "/queue/position-updatesi9oqdfzo" yielding a unique queue name that does not collide with any other user attempting to do the same. Subsequently when messages are sent to "/user/{username}/queue/position-updates", the destination is translated to "/queue/position-updatesi9oqdfzo". The default prefix used to identify such destinations is "/user/".

setUserDestinationPrefix

back to summary

public MessageBrokerRegistry setUserDestinationPrefix(String destinationPrefix)

Configure the prefix used to identify user destinations. User destinations provide the ability for a user to subscribe to queue names unique to their session as well as for others to send messages to those unique, user-specific queues.

For example when a user attempts to subscribe to "/user/queue/position-updates", the destination may be translated to "/queue/position-updatesi9oqdfzo" yielding a unique queue name that does not collide with any other user attempting to do the same. Subsequently when messages are sent to "/user/{username}/queue/position-updates", the destination is translated to "/queue/position-updatesi9oqdfzo".

The default prefix used to identify such destinations is "/user/".

setUserRegistryOrder back to summary

setUserRegistryOrder	back to summary
public void setUserRegistryOrder(int order) Set the order for the `SimpUserRegistry` to use as a `SmartApplicationListener`. Parameters order:int the order value Since 5.0.8

public void setUserRegistryOrder(int order)

Set the order for the SimpUserRegistry to use as a SmartApplicationListener.

Parameters

order:int: the order value

Since

5.0.8

public Class MessageBrokerRegistry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail