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

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getBroadcastDestination()	Return the configured destination for unresolved messages.
MessageSendingOperations<String>	getBrokerMessagingTemplate()	Return the messaging template used to send resolved messages to the broker channel.
@Nullable MessageHeaderInitializer	getHeaderInitializer()	Return the configured header initializer.
int	getPhase()
UserDestinationResolver	getUserDestinationResolver()	Return the configured UserDestinationResolver.
void	handleMessage(Message<?> sourceMessage)	Handle the given message.
final boolean	isRunning()
void	setBroadcastDestination(@Nullable String destination)	Set a destination to broadcast messages to that remain unresolved because the user is not connected.
void	setHeaderInitializer(@Nullable MessageHeaderInitializer headerInitializer)	Configure a custom MessageHeaderInitializer to initialize the headers of resolved target messages.
void	setPhase(int phase)	Set the phase that this handler should run in.
final void	start()
final void	stop()
final void	stop(Runnable callback)
String	toString()

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

isAutoStartup, isPauseable

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

public UserDestinationResolver getUserDestinationResolver()

Return the configured UserDestinationResolver.

setBroadcastDestination

public void setBroadcastDestination(@Nullable String destination)

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

public @Nullable String getBroadcastDestination()

Return the configured destination for unresolved messages.

getBrokerMessagingTemplate

public MessageSendingOperations<String> getBrokerMessagingTemplate()

Return the messaging template used to send resolved messages to the broker channel.

setHeaderInitializer

public void setHeaderInitializer(@Nullable MessageHeaderInitializer headerInitializer)

Configure a custom MessageHeaderInitializer to initialize the headers of resolved target messages.

By default this is not set.

getHeaderInitializer

public @Nullable MessageHeaderInitializer getHeaderInitializer()

Return the configured header initializer.

setPhase

public void setPhase(int phase)

Set the phase that this handler should run in.

By default, this is SmartLifecycle.DEFAULT_PHASE, but with @EnableWebSocketMessageBroker configuration it is set to 0.

Since:

6.1.4

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

start

public final void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public final void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public final void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

handleMessage

public void handleMessage(Message<?> sourceMessage)
                   throws MessagingException

Description copied from interface: MessageHandler

Handle the given message.

Specified by:

handleMessage in interface MessageHandler

Parameters:

sourceMessage - the message to be handled

Throws:

MessagingException - if the handler failed to process the message

toString

public String toString()

Overrides:

toString in class Object