Package org.springframework.messaging.simp.user

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.

Listens for messages with "user" destinations, translates their destination to actual target destinations unique to the active session(s) of a user, and then sends the resolved messages to the broker channel to be delivered.

Since:
4.0
Author:
Rossen Stoyanchev

  • Constructor Details

    • UserDestinationMessageHandler

      public UserDestinationMessageHandler(SubscribableChannel clientInboundChannel, SubscribableChannel brokerChannel, UserDestinationResolver resolver)
      Create an instance with the given client and broker channels subscribing to handle messages from each and then sending any resolved messages to the broker channel.
      Parameters:
      clientInboundChannel - messages received from clients.
      brokerChannel - messages sent to the broker.
      resolver - 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

      @Nullable public 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

      @Nullable public MessageHeaderInitializer getHeaderInitializer()
      Return the configured header initializer.

    • 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<?> message) throws MessagingException
      Description copied from interface: MessageHandler
      Handle the given message.
      Specified by:
      handleMessage in interface MessageHandler
      Parameters:
      message - the message to be handled
      Throws:
      MessagingException - if the handler failed to process the message

    • toString

      public String toString()
      Overrides:
      toString in class Object