com.communote.server.core.messaging

Class NotificationService

java.lang.Object

com.communote.server.core.messaging.NotificationService

@Service
public class NotificationService
extends Object

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
NotificationService()

Method Summary

Modifier and Type	Method and Description
Collection<NotificationDefinition>	getRegisteredDefinitions()
Map<NotificationDefinition,NotificationScheduleTypes>	getUserNotificationSchedules(Long userId) Method to get a map of all set notification definitions and schedules for a given user.
void	postConstruct() Post constructor to register default definitions.
void	register(NotificationDefinition... definitions) Method to register new definitions.
void	saveUserNotificationSchedule(Long userId, NotificationDefinition definition, NotificationScheduleTypes scheduleType) Method to save a setting for the given user.
void	saveUserNotificationSchedules(Long userId, Map<NotificationDefinition,NotificationScheduleTypes> mappings) Method to save schedules for the given user.
void	sendMessage(Long noteId, Long userToNotify, NotificationDefinition notificationDefinition, Map<String,Object> model) Send notifications to users to inform about created or edited notes.
void	sendMessage(Note note, Collection<User> usersToNotify, NotificationDefinition notificationDefinition) Send notifications to users to inform about created or edited notes.
void	unregister(NotificationDefinition... definitions) Method to remove registered definitions.
boolean	userHasSchedule(Long userId, NotificationDefinition definition, NotificationScheduleTypes schedule)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationService

public NotificationService()

Method Detail

getRegisteredDefinitions

public Collection<NotificationDefinition> getRegisteredDefinitions()

Returns:

Collection of all registered definitions.

getUserNotificationSchedules

public Map<NotificationDefinition,NotificationScheduleTypes> getUserNotificationSchedules(Long userId)
                                                                                   throws NotFoundException,
                                                                                          AuthorizationException

Method to get a map of all set notification definitions and schedules for a given user.

Parameters:

userId - The users id.

Returns:

A map of all set notification definitions and schedules

Throws:

NotFoundException - Thrown, when the user was not found.

AuthorizationException - Thrown, when the current user is not allowed to access the given properties.

postConstruct

@PostConstruct
public void postConstruct()

Post constructor to register default definitions.

register

public void register(NotificationDefinition... definitions)

Method to register new definitions.

Parameters:

definitions - The definitions to register.

saveUserNotificationSchedule

public void saveUserNotificationSchedule(Long userId,
                                         NotificationDefinition definition,
                                         NotificationScheduleTypes scheduleType)
                                  throws NotFoundException,
                                         AuthorizationException

Method to save a setting for the given user.

Parameters:

userId - The user to save the setting for.

definition - The definition to save.

scheduleType - The schedule type to set. Use null to delete the setting.

Throws:

NotFoundException - Thrown, when the user doesn't exists.

AuthorizationException - Thrown, when the current user is not allowed to access this settings.

saveUserNotificationSchedules

public void saveUserNotificationSchedules(Long userId,
                                          Map<NotificationDefinition,NotificationScheduleTypes> mappings)
                                   throws NotFoundException,
                                          AuthorizationException

Method to save schedules for the given user.

Parameters:

userId - The user to save the setting for.

mappings - Mappings from definitions to schedules.

Throws:

NotFoundException - Thrown, when the user doesn't exists.

AuthorizationException - Thrown, when the current user is not allowed to access this settings.

sendMessage

public void sendMessage(Long noteId,
                        Long userToNotify,
                        NotificationDefinition notificationDefinition,
                        Map<String,Object> model)

Send notifications to users to inform about created or edited notes.

Parameters:

noteId - Id of the note, which should be send. the note to inform about

userToNotify - Id of the user to notify.

notificationDefinition - The current definition of the notification.

model - Additional elements used for the velocity context.

sendMessage

public void sendMessage(Note note,
                        Collection<User> usersToNotify,
                        NotificationDefinition notificationDefinition)

Send notifications to users to inform about created or edited notes.

Parameters:

note - the note to inform about

usersToNotify - the users to be notified

notificationDefinition - The current definition of the notification.

unregister

public void unregister(NotificationDefinition... definitions)

Method to remove registered definitions.

Parameters:

definitions - The definitions to remove.

userHasSchedule

public boolean userHasSchedule(Long userId,
                               NotificationDefinition definition,
                               NotificationScheduleTypes schedule)

Parameters:

userId - The user.

definition - The definition to check.

schedule - The schedule to check.

Returns:

True, if the use has set the requested scheduling.