Package org.cyclos.impl.messaging

Class MessageServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.messaging.MessageServiceImpl

All Implemented Interfaces:

MessageServiceLocal, MessageService, Service

@Service
public class MessageServiceImpl
extends BaseServiceImpl
implements MessageServiceLocal

Implementation for MessageService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
MessageServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	canSendMessage(MessageDestination destination)	Returns true if the logged user can send a message to the given destination
boolean	canSendMessageToUser(User user)	Returns true if the logged user can send a message to the given destination user.
boolean	canViewMessages()	Returns true if the the logged user can view his messages.
int	countNewMessages()	Return messages count since the last time seen
int	countUnreadMessages()	Return unread messages count
MessageData	getData(Long id)	Returns details data for the given message
MessagesStatusVO	getMessagesStatus()	Returns the messages status containing the unread/new messages and the last view date. The last view date is updated through the UserValidationService.updateUserActivity(org.cyclos.model.users.users.UserActivityType) method with the parameter UserActivityType.MESSAGE.
MessageSearchData	getSearchData()	Returns data used to search messages
SendMessageData	getSendData(Long replyId, UserLocatorVO toUserVO)	Returns data for sending a message.
void	markAsRead(Set<Long> ids, boolean isRead)	Marks all the given message as either read or as unread
void	moveToTrash(Set<Long> ids)	Moves all the given messages to the trash bin
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeAll(Set<Long> ids)	Permanently removes all the given messages
void	removeAll(User user)	Clears all message boxes of the specified user completely, by physically deleting all the messages
void	restoreAll(Set<Long> ids)	Restores the given messages, that is, move them from the trash bin to the original message box (either inbox or sent items)
Page<MessageVO>	search(MessageQuery params)	Searches for messages according to the given criteria
long	send(SendMessageDTO sendMessage)	Sends a message and returns the id of the outgoing message

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageServiceImpl

public MessageServiceImpl()

Method Detail

canSendMessage

public boolean canSendMessage(MessageDestination destination)

Description copied from interface: MessageServiceLocal

Returns true if the logged user can send a message to the given destination

Specified by:

canSendMessage in interface MessageServiceLocal

Parameters:

destination - The destination of the message. If null, it returns true if the logged user can send the message to at least one destination.

canSendMessageToUser

public boolean canSendMessageToUser(User user)

Description copied from interface: MessageServiceLocal

Returns true if the logged user can send a message to the given destination user.

Specified by:

canSendMessageToUser in interface MessageServiceLocal

canViewMessages

public boolean canViewMessages()

Description copied from interface: MessageServiceLocal

Returns true if the the logged user can view his messages. In case of an admin, the method returns true if he can view the system messages.

Specified by:

canViewMessages in interface MessageServiceLocal

countNewMessages

public int countNewMessages()

Description copied from interface: MessageService

Return messages count since the last time seen

Specified by:

countNewMessages in interface MessageService

countUnreadMessages

public int countUnreadMessages()

Description copied from interface: MessageService

Return unread messages count

Specified by:

countUnreadMessages in interface MessageService

getData

public MessageData getData(Long id)
                    throws FrameworkException

Description copied from interface: MessageService

Returns details data for the given message

Specified by:

getData in interface MessageService

Throws:

FrameworkException

getMessagesStatus

public MessagesStatusVO getMessagesStatus()

Description copied from interface: MessageService

Returns the messages status containing the unread/new messages and the last view date.
The last view date is updated through the UserValidationService.updateUserActivity(org.cyclos.model.users.users.UserActivityType) method with the parameter UserActivityType.MESSAGE.

Specified by:

getMessagesStatus in interface MessageService

getSearchData

public MessageSearchData getSearchData()

Description copied from interface: MessageService

Returns data used to search messages

Specified by:

getSearchData in interface MessageService

getSendData

public SendMessageData getSendData(Long replyId,
                                   UserLocatorVO toUserVO)

Description copied from interface: MessageService

Returns data for sending a message. If replyId is given, the new message will be a reply for that one. If toUser is given, the message will be to that specific user.

Specified by:

getSendData in interface MessageService

markAsRead

public void markAsRead(Set<Long> ids,
                       boolean isRead)

Description copied from interface: MessageService

Marks all the given message as either read or as unread

Specified by:

markAsRead in interface MessageService

moveToTrash

public void moveToTrash(Set<Long> ids)

Description copied from interface: MessageService

Moves all the given messages to the trash bin

Specified by:

moveToTrash in interface MessageService

removeAll

public void removeAll(Set<Long> ids)

Description copied from interface: MessageService

Permanently removes all the given messages

Specified by:

removeAll in interface MessageService

removeAll

public void removeAll(User user)

Description copied from interface: MessageServiceLocal

Clears all message boxes of the specified user completely, by physically deleting all the messages

Specified by:

removeAll in interface MessageServiceLocal

restoreAll

public void restoreAll(Set<Long> ids)

Description copied from interface: MessageService

Restores the given messages, that is, move them from the trash bin to the original message box (either inbox or sent items)

Specified by:

restoreAll in interface MessageService

search

public Page<MessageVO> search(MessageQuery params)

Description copied from interface: MessageService

Searches for messages according to the given criteria

Specified by:

search in interface MessageService

send

public long send(SendMessageDTO sendMessage)

Description copied from interface: MessageService

Sends a message and returns the id of the outgoing message

Specified by:

send in interface MessageService

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl