Class UserDestinationMessageHandler
java.lang.Object
org.springframework.messaging.simp.user.UserDestinationMessageHandler
- All Implemented Interfaces:
org.springframework.context.Lifecycle
,org.springframework.context.Phased
,org.springframework.context.SmartLifecycle
,MessageHandler
public class UserDestinationMessageHandler
extends Object
implements MessageHandler, org.springframework.context.SmartLifecycle
MessageHandler
with support for "user" destinations.
Listen for messages with "user" destinations, translate the destination to a target destination that's unique to the active user session(s), and send to the broker channel for delivery.
- Since:
- 4.0
- Author:
- Rossen Stoyanchev
-
Field Summary
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
-
Constructor Summary
ConstructorDescriptionUserDestinationMessageHandler
(SubscribableChannel clientInboundChannel, SubscribableChannel brokerChannel, UserDestinationResolver destinationResolver) Create an instance with the given client and broker channels to subscribe to, and then send resolved messages to the broker channel. -
Method Summary
Modifier and TypeMethodDescriptionReturn the configured destination for unresolved messages.Return the messaging template used to send resolved messages to the broker channel.Return the configured header initializer.Return the configuredUserDestinationResolver
.void
handleMessage
(Message<?> sourceMessage) Handle the given message.final boolean
void
setBroadcastDestination
(String destination) Set a destination to broadcast messages to that remain unresolved because the user is not connected.void
setHeaderInitializer
(MessageHeaderInitializer headerInitializer) Configure a customMessageHeaderInitializer
to initialize the headers of resolved target messages.final void
start()
final void
stop()
final void
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.context.SmartLifecycle
getPhase, isAutoStartup
-
Constructor Details
-
UserDestinationMessageHandler
public UserDestinationMessageHandler(SubscribableChannel clientInboundChannel, SubscribableChannel brokerChannel, UserDestinationResolver destinationResolver) Create an instance with the given client and broker channels to subscribe to, and then send resolved messages to the broker channel.- Parameters:
clientInboundChannel
- messages received from clients.brokerChannel
- messages sent to the broker.destinationResolver
- the resolver for "user" destinations.
-
-
Method Details
-
getUserDestinationResolver
Return the configuredUserDestinationResolver
. -
setBroadcastDestination
Set a destination to broadcast messages to that remain unresolved because the user is not connected. In a multi-application server scenario this gives other application servers a chance to try.By default this is not set.
- Parameters:
destination
- the target destination.
-
getBroadcastDestination
Return the configured destination for unresolved messages. -
getBrokerMessagingTemplate
Return the messaging template used to send resolved messages to the broker channel. -
setHeaderInitializer
Configure a customMessageHeaderInitializer
to initialize the headers of resolved target messages.By default this is not set.
-
getHeaderInitializer
Return the configured header initializer. -
start
public final void start()- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
stop
public final void stop()- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
stop
- Specified by:
stop
in interfaceorg.springframework.context.SmartLifecycle
-
isRunning
public final boolean isRunning()- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-
handleMessage
Description copied from interface:MessageHandler
Handle the given message.- Specified by:
handleMessage
in interfaceMessageHandler
- Parameters:
sourceMessage
- the message to be handled- Throws:
MessagingException
- if the handler failed to process the message
-
toString
-