Modifier and Type	Class and Description
private static class	UserDestinationMessageHandler.BroadcastHandler A handler that broadcasts locally unresolved messages to the broker and also handles similar broadcasts received from the broker.
private static class	UserDestinationMessageHandler.SendHelper

Modifier and Type	Field and Description
private UserDestinationMessageHandler.BroadcastHandler	broadcastHandler
private final SubscribableChannel	brokerChannel
private final SubscribableChannel	clientInboundChannel
private final UserDestinationResolver	destinationResolver
private MessageHeaderInitializer	headerInitializer
private final Object	lifecycleMonitor
private static final Log	logger
private Integer	phase
private volatile boolean	running
private final UserDestinationMessageHandler.SendHelper	sendHelper

Access	Constructor and Description
public	UserDestinationMessageHandler(SubscribableChannel messages received from clients. clientInboundChannel, SubscribableChannel messages sent to the broker. brokerChannel, UserDestinationResolver the resolver for "user" destinations. 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 and Description
public String	getBroadcastDestination() Return the configured destination for unresolved messages.
public MessageSendingOperations<String>	getBrokerMessagingTemplate() Return the messaging template used to send resolved messages to the broker channel.
public MessageHeaderInitializer	getHeaderInitializer() Return the configured header initializer.
public int	getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Return the phase that this lifecycle object is supposed to run in. The default implementation returns `DEFAULT_PHASE` in order to let `stop()` callbacks execute before regular `Lifecycle` implementations.
public UserDestinationResolver	getUserDestinationResolver() Return the configured `UserDestinationResolver`.
public void	handleMessage(Message<?> the message to be handled sourceMessage) Implements org.springframework.messaging.MessageHandler.handleMessage. Handle the given message.
private void	initHeaders(SimpMessageHeaderAccessor headerAccessor)
public final boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running.
public void	setBroadcastDestination(String the target destination. destination) Set a destination to broadcast messages to that remain unresolved because the user is not connected.
public void	setHeaderInitializer(MessageHeaderInitializer headerInitializer) Configure a custom `MessageHeaderInitializer` to initialize the headers of resolved target messages.
public void	setPhase(int phase) Set the phase that this handler should run in. By default, this is `SmartLifecycle#DEFAULT_PHASE`.
public final void	start() Implements org.springframework.context.Lifecycle.start. Start this component.
public final void	stop() Implements org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
public final void	stop(Runnable callback) Overrides default org.springframework.context.SmartLifecycle.stop. Indicates that a Lifecycle component must stop if it is currently running.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

broadcastHandler	back to summary
private UserDestinationMessageHandler.BroadcastHandler broadcastHandler Annotations @Nullable

brokerChannel	back to summary
private final SubscribableChannel brokerChannel

clientInboundChannel	back to summary
private final SubscribableChannel clientInboundChannel

destinationResolver	back to summary
private final UserDestinationResolver destinationResolver

headerInitializer	back to summary
private MessageHeaderInitializer headerInitializer Annotations @Nullable

lifecycleMonitor	back to summary
private final Object lifecycleMonitor

logger	back to summary
private static final Log logger

phase	back to summary
private Integer phase Annotations @Nullable

running	back to summary
private volatile boolean running

sendHelper	back to summary
private final UserDestinationMessageHandler.SendHelper sendHelper

Constructor Detail

UserDestinationMessageHandler	back to summary
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:SubscribableChannel messages received from clients. brokerChannel:SubscribableChannel messages sent to the broker. destinationResolver:UserDestinationResolver the resolver for "user" destinations.

UserDestinationMessageHandler

back to summary

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:SubscribableChannel: messages received from clients.
brokerChannel:SubscribableChannel: messages sent to the broker.
destinationResolver:UserDestinationResolver: the resolver for "user" destinations.

Method Detail

getBroadcastDestination	back to summary
public String getBroadcastDestination() Return the configured destination for unresolved messages. Annotations @Nullable

getBroadcastDestination

back to summary

public String getBroadcastDestination()

Return the configured destination for unresolved messages.

Annotations

@Nullable

getBrokerMessagingTemplate	back to summary
public MessageSendingOperations<String> getBrokerMessagingTemplate() Return the messaging template used to send resolved messages to the broker channel.

getHeaderInitializer	back to summary
public MessageHeaderInitializer getHeaderInitializer() Return the configured header initializer. Annotations @Nullable

getHeaderInitializer

back to summary

public MessageHeaderInitializer getHeaderInitializer()

Return the configured header initializer.

Annotations

@Nullable

getPhase back to summary

getPhase	back to summary
public int getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Doc from org.springframework.context.SmartLifecycle.getPhase. Return the phase that this lifecycle object is supposed to run in. The default implementation returns `DEFAULT_PHASE` in order to let `stop()` callbacks execute before regular `Lifecycle` implementations. Annotations @Override

public int getPhase()

Overrides default org.springframework.context.SmartLifecycle.getPhase.

Doc from org.springframework.context.SmartLifecycle.getPhase.

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

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

Annotations

@Override

getUserDestinationResolver	back to summary
public UserDestinationResolver getUserDestinationResolver() Return the configured `UserDestinationResolver`.

handleMessage	back to summary
public void handleMessage(Message<?> sourceMessage) throws MessagingException Implements org.springframework.messaging.MessageHandler.handleMessage. Doc from org.springframework.messaging.MessageHandler.handleMessage. Handle the given message. Parameters sourceMessage:Message<?> the message to be handled Annotations @Override Exceptions MessagingException: if the handler failed to process the message

handleMessage

back to summary

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

Implements org.springframework.messaging.MessageHandler.handleMessage.

Doc from org.springframework.messaging.MessageHandler.handleMessage.

Handle the given message.

Parameters

sourceMessage:Message<?>: the message to be handled

Annotations

@Override

Exceptions

MessagingException:: if the handler failed to process the message

initHeaders	back to summary
private void initHeaders(SimpMessageHeaderAccessor headerAccessor)

isRunning back to summary

isRunning	back to summary
public final boolean isRunning() Implements org.springframework.context.Lifecycle.isRunning. Doc from org.springframework.context.Lifecycle.isRunning. 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. Returns:boolean whether the component is currently running Annotations @Override

public final boolean isRunning()

Implements org.springframework.context.Lifecycle.isRunning.

Doc from org.springframework.context.Lifecycle.isRunning.

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.

Returns:boolean

whether the component is currently running

Annotations

@Override

setBroadcastDestination	back to summary
public void setBroadcastDestination(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:String the target destination.

setBroadcastDestination

back to summary

public void setBroadcastDestination(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:String: the target destination.

setHeaderInitializer back to summary

setHeaderInitializer	back to summary
public void setHeaderInitializer(MessageHeaderInitializer headerInitializer) Configure a custom `MessageHeaderInitializer` to initialize the headers of resolved target messages. By default this is not set.

public void setHeaderInitializer(MessageHeaderInitializer headerInitializer)

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

By default this is not set.

setPhase back to summary

setPhase	back to summary
public void setPhase(int phase) Set the phase that this handler should run in. By default, this is `SmartLifecycle#DEFAULT_PHASE`. Since 6.1.4

public void setPhase(int phase)

Set the phase that this handler should run in.

By default, this is SmartLifecycle#DEFAULT_PHASE.

Since: 6.1.4

start	back to summary
public final void start() Implements org.springframework.context.Lifecycle.start. Doc from org.springframework.context.Lifecycle.start. Start this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate the start signal to all components that apply. Annotations @Override

start

back to summary

public final void start()

Implements org.springframework.context.Lifecycle.start.

Doc from org.springframework.context.Lifecycle.start.

Start this component.

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

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

Annotations

@Override

stop back to summary

stop	back to summary
public final void stop() Implements org.springframework.context.Lifecycle.stop. Doc from org.springframework.context.Lifecycle.stop. 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. Annotations @Override

public final void stop()

Implements org.springframework.context.Lifecycle.stop.

Doc from org.springframework.context.Lifecycle.stop.

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.

Annotations

@Override

stop back to summary

stop	back to summary
public final void stop(Runnable callback) Overrides default org.springframework.context.SmartLifecycle.stop. Doc from org.springframework.context.SmartLifecycle.stop. 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 `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). Annotations @Override

public final void stop(Runnable callback)

Overrides default org.springframework.context.SmartLifecycle.stop.

Doc from org.springframework.context.SmartLifecycle.stop.

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 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).

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.springframework.messaging.simp.user back to summary

private Class UserDestinationMessageHandler.BroadcastHandler

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.user.UserDestinationMessageHandler.BroadcastHandler

A handler that broadcasts locally unresolved messages to the broker and also handles similar broadcasts received from the broker.

Field Summary

Modifier and Type	Field and Description
private final String	broadcastDestination
private final MessageSendingOperations<String>	messagingTemplate
private static final List<String>	NO_COPY_LIST

Constructor Summary

Access	Constructor and Description
public	BroadcastHandler(MessageSendingOperations<String> template, String destination)

Method Summary

Modifier and Type	Method and Description
public String	getBroadcastDestination()
public void	handleUnresolved(Message<?> message)
public Message<?>	preHandle(Message<?> message)

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

Field Detail

broadcastDestination	back to summary
private final String broadcastDestination

messagingTemplate	back to summary
private final MessageSendingOperations<String> messagingTemplate

NO_COPY_LIST	back to summary
private static final List<String> NO_COPY_LIST

Constructor Detail

BroadcastHandler	back to summary
public BroadcastHandler(MessageSendingOperations<String> template, String destination)

Method Detail

getBroadcastDestination	back to summary
public String getBroadcastDestination()

handleUnresolved	back to summary
public void handleUnresolved(Message<?> message)

preHandle	back to summary
public Message<?> preHandle(Message<?> message) throws MessagingException Annotations @Nullable

org.springframework.messaging.simp.user back to summary

private Class UserDestinationMessageHandler.SendHelper

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.user.UserDestinationMessageHandler.SendHelper

Field Summary

Modifier and Type	Field and Description
private final MessageChannel	brokerChannel
private final MessageSendingOperations<String>	messagingTemplate
private final Map<String, MessageSendingOperations<String>>	orderedMessagingTemplates

Constructor Summary

Access	Constructor and Description
pack-priv	SendHelper(MessageChannel clientInboundChannel, MessageChannel brokerChannel)

Method Summary

Modifier and Type	Method and Description
public void	checkDisconnect(Message<?> message)
public MessageSendingOperations<String>	getMessagingTemplate()
private MessageSendingOperations<String>	getTemplateToUse(String sessionId)
public void	send(UserDestinationResult destinationResult, Message<?> message)

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

Field Detail

brokerChannel	back to summary
private final MessageChannel brokerChannel

messagingTemplate	back to summary
private final MessageSendingOperations<String> messagingTemplate

orderedMessagingTemplates	back to summary
private final Map<String, MessageSendingOperations<String>> orderedMessagingTemplates Annotations @Nullable

Constructor Detail

SendHelper	back to summary
pack-priv SendHelper(MessageChannel clientInboundChannel, MessageChannel brokerChannel)

Method Detail

checkDisconnect	back to summary
public void checkDisconnect(Message<?> message)

getMessagingTemplate	back to summary
public MessageSendingOperations<String> getMessagingTemplate()

getTemplateToUse	back to summary
private MessageSendingOperations<String> getTemplateToUse(String sessionId)

send	back to summary
public void send(UserDestinationResult destinationResult, Message<?> message) throws MessagingException

public Class UserDestinationMessageHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class UserDestinationMessageHandler.BroadcastHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class UserDestinationMessageHandler.SendHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail