Class AbstractBrokerMessageHandler
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationEventPublisherAware
,org.springframework.context.Lifecycle
,org.springframework.context.Phased
,org.springframework.context.SmartLifecycle
,MessageHandler
- Direct Known Subclasses:
SimpleBrokerMessageHandler
,StompBrokerRelayMessageHandler
MessageHandler
that broker messages to
registered subscribers.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
-
Field Summary
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
-
Constructor Summary
ConstructorDescriptionAbstractBrokerMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel) Constructor with no destination prefixes (matches all destinations).AbstractBrokerMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Constructor with destination prefixes to match to destinations of messages. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
checkDestinationPrefix
(String destination) Whether a message with the given destination should be processed.org.springframework.context.ApplicationEventPublisher
protected MessageChannel
getClientOutboundChannelForSession
(String sessionId) Get the MessageChannel to use for sending messages to clients, possibly a per-session wrapper whenpreservePublishOrder=true
.Return destination prefixes to use to filter messages to forward to the broker.void
handleMessage
(Message<?> message) Handle the given message.protected abstract void
handleMessageInternal
(Message<?> message) boolean
boolean
Whether the message broker is currently available and able to process messages.boolean
Whether to ensure messages are received in the order of publication.final boolean
Check whether this message handler is currently running.protected void
protected void
void
setApplicationEventPublisher
(org.springframework.context.ApplicationEventPublisher publisher) void
setAutoStartup
(boolean autoStartup) void
setPreservePublishOrder
(boolean preservePublishOrder) Whether the client must receive messages in the order of publication.void
setUserDestinationPredicate
(Predicate<String> predicate) Configure a Predicate to identify messages with a user destination.void
start()
protected void
void
stop()
final void
protected void
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.context.SmartLifecycle
getPhase
-
Field Details
-
logger
protected final org.apache.commons.logging.Log logger
-
-
Constructor Details
-
AbstractBrokerMessageHandler
public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel) Constructor with no destination prefixes (matches all destinations).- Parameters:
inboundChannel
- the channel for receiving messages from clients (e.g. WebSocket clients)outboundChannel
- the channel for sending messages to clients (e.g. WebSocket clients)brokerChannel
- the channel for the application to send messages to the broker
-
AbstractBrokerMessageHandler
public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel, @Nullable Collection<String> destinationPrefixes) Constructor with destination prefixes to match to destinations of messages.- Parameters:
inboundChannel
- the channel for receiving messages from clients (e.g. WebSocket clients)outboundChannel
- the channel for sending messages to clients (e.g. WebSocket clients)brokerChannel
- the channel for the application to send messages to the brokerdestinationPrefixes
- prefixes to use to filter out messages
-
-
Method Details
-
getClientInboundChannel
-
getClientOutboundChannel
-
getBrokerChannel
-
getDestinationPrefixes
Return destination prefixes to use to filter messages to forward to the broker. Messages that have a destination and where the destination doesn't match are ignored.By default this is not set.
-
setUserDestinationPredicate
Configure a Predicate to identify messages with a user destination. When nodestination prefixes
are configured, this helps to recognize and skip user destination messages that need to be pre-processed by theUserDestinationMessageHandler
before they reach the broker.- Parameters:
predicate
- the predicate to identify user messages with a non-null destination as messages with a user destinations.- Since:
- 5.3.4
-
setPreservePublishOrder
public void 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. Enable this only if needed since there is some performance overhead to keep messages in order.- Parameters:
preservePublishOrder
- whether to publish in order- Since:
- 5.1
-
isPreservePublishOrder
public boolean isPreservePublishOrder()Whether to ensure messages are received in the order of publication.- Since:
- 5.1
-
setApplicationEventPublisher
public void setApplicationEventPublisher(@Nullable org.springframework.context.ApplicationEventPublisher publisher) - Specified by:
setApplicationEventPublisher
in interfaceorg.springframework.context.ApplicationEventPublisherAware
-
getApplicationEventPublisher
@Nullable public org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher() -
setAutoStartup
public void setAutoStartup(boolean autoStartup) -
isAutoStartup
public boolean isAutoStartup()- Specified by:
isAutoStartup
in interfaceorg.springframework.context.SmartLifecycle
-
start
public void start()- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
startInternal
protected void startInternal() -
stop
public void stop()- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
stopInternal
protected void stopInternal() -
stop
- Specified by:
stop
in interfaceorg.springframework.context.SmartLifecycle
-
isRunning
public final boolean isRunning()Check whether this message handler is currently running.Note that even when this message handler is running the
isBrokerAvailable()
flag may still independently alternate between being on and off depending on the concrete subclass implementation.- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-
isBrokerAvailable
public boolean isBrokerAvailable()Whether the message broker is currently available and able to process messages.Note that this is in addition to the
isRunning()
flag, which indicates whether this message handler is running. In other words the message handler must first be running and then the#isBrokerAvailable()
flag may still independently alternate between being on and off depending on the concrete subclass implementation.Application components may implement
org.springframework.context.ApplicationListener<BrokerAvailabilityEvent>
to receive notifications when broker becomes available and unavailable. -
handleMessage
Description copied from interface:MessageHandler
Handle the given message.- Specified by:
handleMessage
in interfaceMessageHandler
- Parameters:
message
- the message to be handled
-
handleMessageInternal
-
checkDestinationPrefix
Whether a message with the given destination should be processed. This is the case if one of the following conditions is true:- The destination starts with one of the configured
destination prefixes
. - No prefixes are configured and the destination isn't matched
by the
userDestinationPredicate
. - The message has no destination.
- Parameters:
destination
- the destination to check- Returns:
- whether to process (true) or skip (false) the destination
- The destination starts with one of the configured
-
publishBrokerAvailableEvent
protected void publishBrokerAvailableEvent() -
getClientOutboundChannelForSession
Get the MessageChannel to use for sending messages to clients, possibly a per-session wrapper whenpreservePublishOrder=true
.- Since:
- 5.1
-