Package org.cyclos.security.messaging

Class MessageServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.messaging.MessageServiceSecurity

All Implemented Interfaces:

MessageService, Service

@Security
public class MessageServiceSecurity
extends BaseServiceSecurity
implements MessageService

Security layer 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
MessageServiceSecurity()

Method Summary

Modifier and Type	Method	Description
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
MessageSearchData	getSearchData()	Returns data used to search messages
SendMessageData	getSendData(Long replyId, UserLocatorVO toUserVO)	Returns data for sending a message.
SendInviteMessageData	getSendInviteMessageData()	Returns data for sending an invite 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
void	removeAll(Set<Long> ids)	Permanently removes all the given messages
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
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 query)	Searches for messages according to the given criteria
void	send(SendMessageDTO params)	Sends a message
void	sendInviteMessage(SendInviteMessageDTO inviteMessageDTO)	Sends an invitation message to the destination addresses

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, 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

MessageServiceSecurity

public MessageServiceSecurity()

Method Detail

countNewMessages

public int countNewMessages()
                     throws FrameworkException

Description copied from interface: MessageService

Return messages count since the last time seen

Specified by:

countNewMessages in interface MessageService

Throws:

FrameworkException

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

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

getSendInviteMessageData

public SendInviteMessageData getSendInviteMessageData()

Description copied from interface: MessageService

Returns data for sending an invite message

Specified by:

getSendInviteMessageData 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

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 query)

Description copied from interface: MessageService

Searches for messages according to the given criteria

Specified by:

search in interface MessageService

send

public void send(SendMessageDTO params)

Description copied from interface: MessageService

Sends a message

Specified by:

send in interface MessageService

sendInviteMessage

public void sendInviteMessage(SendInviteMessageDTO inviteMessageDTO)

Description copied from interface: MessageService

Sends an invitation message to the destination addresses

Specified by:

sendInviteMessage in interface MessageService

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity