Spring Messaging 6.1.4 · org.springframework.messaging.simp.user

Support for handling messages to "user" destinations (i.e. destinations that are unique to a user's sessions), primarily translating the destinations and then forwarding the updated message to the broker.

Also included is org.springframework.messaging.simp.user.SimpUserRegistry for keeping track of connected user sessions.

Interface Summary

Modifier and Type	Interface and Description
public interface	DestinationUserNameProvider A `java.security.Principal` can also implement this contract when `getName()` isn't globally unique and therefore not suited for use with "user" destinations.
public interface	SimpSession Represents a session of connected user.
public interface	SimpSubscription Represents a subscription within a user session.
public interface	SimpSubscriptionMatcher A strategy for matching subscriptions.
public interface	SimpUser Represents a connected user.
public interface	SimpUserRegistry A registry of currently connected users.
public interface	UserDestinationResolver A strategy for resolving a "user" destination by translating it to one or more actual destinations one per active user session.

Class Summary

Modifier and Type	Class and Description
public class	DefaultUserDestinationResolver A default implementation of `UserDestinationResolver` that relies on a `SimpUserRegistry` to find active sessions for a user.
public class	MultiServerUserRegistry `SimpUserRegistry` that looks up users in a "local" user registry as well as a set of "remote" user registries.
public class	UserDestinationMessageHandler `MessageHandler` with support for "user" destinations.
public class	UserDestinationResult Contains the result from parsing a "user" destination from a source message and translating it to target destinations (one per active user session).
public class	UserRegistryMessageHandler `MessageHandler` that handles user registry broadcasts from other application servers and periodically broadcasts the content of the local user registry.

Package org.springframework.messaging.simp.user

Interface Summary

Class Summary