info.magnolia.ui.framework.message
Class MessagesManagerImpl

java.lang.Object
  info.magnolia.ui.framework.message.MessagesManagerImpl

All Implemented Interfaces:

MessagesManager

@Singleton
public class MessagesManagerImpl
extends Object
implements MessagesManager

Implementation of MessagesManager.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.ui.framework.message.MessagesManager

MessagesManager.MessageListener

Constructor Summary

MessagesManagerImpl(javax.inject.Provider<info.magnolia.cms.security.SecuritySupport> securitySupportProvider, MessageStore messageStore)

Method Summary

void	broadcastMessage(Message message) Sends a message to all users.
void	clearMessage(String userName, String messageId) Marks a message as cleared.
Message	getMessageById(String userName, String messageId) Returns a message.
List<Message>	getMessagesForUser(String userName) Returns all messages kept for a specific user.
int	getNumberOfUnclearedMessagesForUser(String userName) Returns the number of uncleared (unread) messages for this user.
int	getNumberOfUnclearedMessagesForUserAndByType(String userName, MessageType type) Returns the number of uncleared (unread) messages for this user and for the specific message type.
void	registerMessagesListener(String userName, MessagesManager.MessageListener listener) Beware: this method is for registering message listeners and should only be used by the entry point of our application AdmincentralUI where we register a dispatcher.
void	removeMessage(String userName, String messageId)
void	sendGroupMessage(String groupName, Message message) Send message to a specific group.
void	sendLocalMessage(Message message) Send message to the current user.
void	sendMessage(String userName, Message message) Send message to a specific user.
void	unregisterMessagesListener(String userName, MessagesManager.MessageListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesManagerImpl

@Inject
public MessagesManagerImpl(javax.inject.Provider<info.magnolia.cms.security.SecuritySupport> securitySupportProvider,
                                  MessageStore messageStore)

Method Detail

broadcastMessage

public void broadcastMessage(Message message)

Description copied from interface: MessagesManager

Sends a message to all users.

Specified by:

broadcastMessage in interface MessagesManager

Parameters:

message - message to send

sendMessage

public void sendMessage(String userName,
                        Message message)

Description copied from interface: MessagesManager

Send message to a specific user.

Specified by:

sendMessage in interface MessagesManager

Parameters:

userName - name of the user to receive the message

message - message to send

sendGroupMessage

public void sendGroupMessage(String groupName,
                             Message message)

Description copied from interface: MessagesManager

Send message to a specific group.

Specified by:

sendGroupMessage in interface MessagesManager

Parameters:

groupName - name of the group to receive the message

message - message to send

sendLocalMessage

public void sendLocalMessage(Message message)

Description copied from interface: MessagesManager

Send message to the current user.

Specified by:

sendLocalMessage in interface MessagesManager

Parameters:

message - message to send

clearMessage

public void clearMessage(String userName,
                         String messageId)

Description copied from interface: MessagesManager

Marks a message as cleared.

Specified by:

clearMessage in interface MessagesManager

Parameters:

userName - name of the user the message belongs to

messageId - id of message

getNumberOfUnclearedMessagesForUser

public int getNumberOfUnclearedMessagesForUser(String userName)

Description copied from interface: MessagesManager

Returns the number of uncleared (unread) messages for this user.

Specified by:

getNumberOfUnclearedMessagesForUser in interface MessagesManager

Parameters:

userName - name of the user

Returns:

number of uncleared messages

getMessagesForUser

public List<Message> getMessagesForUser(String userName)

Description copied from interface: MessagesManager

Returns all messages kept for a specific user.

Specified by:

getMessagesForUser in interface MessagesManager

Parameters:

userName - name of the user

Returns:

list of messages kept for the user

getMessageById

public Message getMessageById(String userName,
                              String messageId)

Description copied from interface: MessagesManager

Returns a message.

Specified by:

getMessageById in interface MessagesManager

Parameters:

userName - name of the user

Returns:

list of messages kept for the user

registerMessagesListener

public void registerMessagesListener(String userName,
                                     MessagesManager.MessageListener listener)

Description copied from interface: MessagesManager

Beware: this method is for registering message listeners and should only be used by the entry point of our application AdmincentralUI where we register a dispatcher. If you'll use it to register your own MessageListeners this likely to introduce a memory leak. You should listen to the MessageEvent instead.

Specified by:

registerMessagesListener in interface MessagesManager

unregisterMessagesListener

public void unregisterMessagesListener(String userName,
                                       MessagesManager.MessageListener listener)

Specified by:

unregisterMessagesListener in interface MessagesManager

removeMessage

public void removeMessage(String userName,
                          String messageId)

Specified by:

removeMessage in interface MessagesManager

getNumberOfUnclearedMessagesForUserAndByType

public int getNumberOfUnclearedMessagesForUserAndByType(String userName,
                                                        MessageType type)

Description copied from interface: MessagesManager

Returns the number of uncleared (unread) messages for this user and for the specific message type.

Specified by:

getNumberOfUnclearedMessagesForUserAndByType in interface MessagesManager