ch.rasc.wampspring.user

Class UserEventMessenger

java.lang.Object

ch.rasc.wampspring.user.UserEventMessenger

public class UserEventMessenger
extends Object

Enhanced EventMessenger that has additional methods that allow a sender to send EventMessage to a given username in addition to a WebSocket session id. This class is not registered by default. See AbstractUserWampConfigurer for configuration.

See Also:

AbstractUserWampConfigurer, EventMessenger

Constructor Summary

Constructors

Constructor and Description
UserEventMessenger(EventMessenger eventMessenger, org.springframework.messaging.simp.user.UserSessionRegistry userSessionRegistry)

Method Summary

Modifier and Type	Method and Description
void	send(EventMessage eventMessage)
void	sendDirect(EventMessage eventMessage)
void	sendTo(String topicURI, Object event, Set<String> eligibleSessionIds)
void	sendTo(String topicURI, Object event, String eligibleSessionId)
void	sendToAll(String topicURI, Object event)
void	sendToAllExcept(String topicURI, Object event, Set<String> excludeSessionIds)
void	sendToAllExcept(String topicURI, Object event, String excludeSessionId)
void	sendToAllExceptUser(String topicURI, Object event, String excludeUser) Send an EventMessage to every client that is currently subscribed to the provided topicURI except the one provided with the excludeUser parameter.
void	sendToAllExceptUsers(String topicURI, Object event, Set<String> excludeUsers) Send an EventMessage to every client that is currently subscribed to the provided topicURI except the ones listed in the excludeUsers set.
void	sendToDirect(String topicURI, Object event, Set<String> webSocketSessionIds)
void	sendToDirect(String topicURI, Object event, String webSocketSessionId)
void	sendToUser(String topicURI, Object event, String eligibleUser) Send an EventMessage to one client that is subscribed to the given topicURI.
void	sendToUserDirect(String topicURI, Object event, String user) Send an EventMessage directly to the client specified with the user parameter.
void	sendToUsers(String topicURI, Object event, Set<String> eligibleUsers) Send an EventMessage to every client that is currently subscribed to the given topicURI and are listed in the eligibleUsers set.
void	sendToUsersDirect(String topicURI, Object event, Set<String> users) Send an EventMessage directly to each client listed in the users set parameter.
void	setSendTimeout(long sendTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserEventMessenger

public UserEventMessenger(EventMessenger eventMessenger,
                          org.springframework.messaging.simp.user.UserSessionRegistry userSessionRegistry)

Method Detail

setSendTimeout

public void setSendTimeout(long sendTimeout)

send

public void send(EventMessage eventMessage)

sendToAll

public void sendToAll(String topicURI,
                      Object event)

sendToAllExcept

public void sendToAllExcept(String topicURI,
                            Object event,
                            String excludeSessionId)

sendToAllExcept

public void sendToAllExcept(String topicURI,
                            Object event,
                            Set<String> excludeSessionIds)

sendTo

public void sendTo(String topicURI,
                   Object event,
                   Set<String> eligibleSessionIds)

sendTo

public void sendTo(String topicURI,
                   Object event,
                   String eligibleSessionId)

sendToDirect

public void sendToDirect(String topicURI,
                         Object event,
                         Set<String> webSocketSessionIds)

sendToDirect

public void sendToDirect(String topicURI,
                         Object event,
                         String webSocketSessionId)

sendDirect

public void sendDirect(EventMessage eventMessage)

sendToAllExceptUser

public void sendToAllExceptUser(String topicURI,
                                Object event,
                                String excludeUser)

Send an EventMessage to every client that is currently subscribed to the provided topicURI except the one provided with the excludeUser parameter.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

user - the user that will be excluded

sendToAllExceptUsers

public void sendToAllExceptUsers(String topicURI,
                                 Object event,
                                 Set<String> excludeUsers)

Send an EventMessage to every client that is currently subscribed to the provided topicURI except the ones listed in the excludeUsers set.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

excludeUsers - a set of users that will be excluded. If null or empty no user will be excluded.

sendToUsers

public void sendToUsers(String topicURI,
                        Object event,
                        Set<String> eligibleUsers)

Send an EventMessage to every client that is currently subscribed to the given topicURI and are listed in the eligibleUsers set. If no user of the provided set is subscribed to the topicURI nothing happens.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

eligibleUsers - only the users listed here will receive the EVENT message. If null or empty nobody receives the message.

sendToUser

public void sendToUser(String topicURI,
                       Object event,
                       String eligibleUser)

Send an EventMessage to one client that is subscribed to the given topicURI. If the client with the given user name is not subscribed to the topicURI nothing happens.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

eligibleUser - only the user listed here will receive the message

sendToUsersDirect

public void sendToUsersDirect(String topicURI,
                              Object event,
                              Set<String> users)

Send an EventMessage directly to each client listed in the users set parameter. A user is ignored if there is no entry in the UserSessionRegistry for his username.

In contrast to sendToUsers(String, Object, Set) this method does not check if the receivers are subscribed to the destination. The SimpleBrokerMessageHandler is not involved in sending these messages.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

users - list of receivers for the EVENT message

sendToUserDirect

public void sendToUserDirect(String topicURI,
                             Object event,
                             String user)

Send an EventMessage directly to the client specified with the user parameter. If there is no entry in the UserSessionRegistry for this user nothing happens.

In contrast to sendToUser(String, Object, String) this method does not check if the receiver is subscribed to the destination. The SimpleBrokerMessageHandler is not involved in sending this message.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

user - receiver of the EVENT message