spring-framework / org.springframework.messaging.simp.config / MessageBrokerRegistry / setUserDestinationPrefix

setUserDestinationPrefix

open fun setUserDestinationPrefix(destinationPrefix: String): MessageBrokerRegistry

Configure the prefix used to identify user destinations. User destinations provide the ability for a user to subscribe to queue names unique to their session as well as for others to send messages to those unique, user-specific queues.

For example when a user attempts to subscribe to "/user/queue/position-updates", the destination may be translated to "/queue/position-updatesi9oqdfzo" yielding a unique queue name that does not collide with any other user attempting to do the same. Subsequently when messages are sent to "/user/{username}/queue/position-updates", the destination is translated to "/queue/position-updatesi9oqdfzo".

The default prefix used to identify such destinations is "/user/".