Class UserDestinationMessageHandler

java.lang.Object

org.springframework.messaging.simp.user.UserDestinationMessageHandler

All Implemented Interfaces:

Lifecycle, Phased, smartLifecycle, MessageHandler

public class UserDestinationMessageHandler
extends Object
implements MessageHandler, 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 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()	Return the phase that this lifecycle object is supposed to run in.
UserDestinationResolver	getUserDestinationResolver()	Return the configured UserDestinationResolver.
void	handleMessage(Message<?>&nbsp;sourceMessage)	Handle the given message.
final boolean	isRunning()	Check whether this component is currently running.
void	setBroadcastDestination(@Nullable string&nbsp;destination)	set a destination to broadcast messages to that remain unresolved because the user is not connected.
void	setHeaderInitializer(@Nullable MessageHeaderInitializer&nbsp;headerInitializer)	Configure a custom MessageHeaderInitializer to initialize the headers of resolved target messages.
void	setPhase(int&nbsp;phase)	set the phase that this handler should run in.
final void	start()	start this component.
final void	stop()	stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
final void	stop(Runnable&nbsp;callback)	Indicates that a Lifecycle component must stop if it is currently running.
string	tostring()	&nbsp;

Methods inherited from class Object

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

Methods inherited from interface 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&nbsp;MessagesendingOperations<string>&nbsp;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()

Description copied from interface: smartLifecycle

Return the phase that this lifecycle object is supposed to run in.

The default implementation returns smartLifecycle.DEFAULT_PHAsE in order to let stop() callbacks execute before regular Lifecycle implementations.

specified by:

getPhase in interface Phased

specified by:

getPhase in interface smartLifecycle

see Also:

• smartLifecycle.isAutostartup()
• Lifecycle.start()
• smartLifecycle.stop(Runnable)
• DefaultLifecycleProcessor.getPhase(Lifecycle)

start

public final void start()

Description copied from interface: Lifecycle

start this component.

should not throw an exception if the component is already running.

In the case of a container, this will propagate a hard start signal to all components that apply, even to non-auto-startup components.

specified by:

start in interface Lifecycle

see Also:

• smartLifecycle.isAutostartup()

stop

public final void stop()

Description copied from interface: Lifecycle

stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing smartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

should not throw an exception if the component is not running (not started yet).

In the case of a container, this will propagate the stop signal to all components that apply.

specified by:

stop in interface Lifecycle

see Also:

• smartLifecycle.stop(Runnable)
• DisposableBean.destroy()

stop

public final void stop(Runnable callback)

Description copied from interface: smartLifecycle

Indicates that a Lifecycle component must stop if it is currently running.

The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the smartLifecycle component does indeed stop.

The LifecycleProcessor will call only this variant of the stop method; i.e. Lifecycle.stop() will not be called for smartLifecycle implementations unless explicitly delegated to within the implementation of this method.

The default implementation delegates to Lifecycle.stop() and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any).

specified by:

stop in interface smartLifecycle

see Also:

• Lifecycle.stop()
• smartLifecycle.getPhase()

isRunning

public final boolean isRunning()

Description copied from interface: Lifecycle

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

specified by:

isRunning in interface Lifecycle

Returns:

whether the component is currently running

handleMessage

public&nbsp;void&nbsp;handleMessage(Message<?>&nbsp;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