Package org.ametys.plugins.workspaces.project.notification.preferences

Class NotificationPreferencesHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.notification.preferences.NotificationPreferencesHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class NotificationPreferencesHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for notifications preferences

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NotificationPreferencesHelper.Frequency	The frequency of notifications

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	To get the current user
protected JSONUtils	_jsonUtils	The JSON utils
protected ProjectManager	_projectManager	The project manager
protected UserPreferencesExtensionPoint	_userPrefEP	The user preferences extension point
protected UserPreferencesManager	_userPrefManager	The user preferences manager
static final String	ROLE	The avalon role
static final String	USERPREFS_ID	the id of the user prefs for notification preferences

Constructor Summary

Constructors

Constructor	Description
NotificationPreferencesHelper()

Method Summary

Modifier and Type	Method	Description
boolean	askedToBeNotified(UserIdentity userIdentity, String projectName, NotificationPreferencesHelper.Frequency frequency)	Determines if a user asked to be notify for a given project and frequency
boolean	askedToBeNotified(User user, String projectName, NotificationPreferencesHelper.Frequency frequency)	Determines if a user asked to be notify for a given project and frequency
void	deleteProjectNotificationPreferences(UserIdentity userIdentity, String projectName)	Delete the user preferences for notification on the given project
Map<String,Object>	getNotificationPreferences(User user)	Get the user's notification preferences
Map<String,Object>	getNotificationPreferences(UserIdentity userIdentity)	Get the user's notification preferences
String	getNotificationPreferencesAsString(User user)	Get the user's notification preferences as json String
String	getNotificationPreferencesAsString(UserIdentity userIdentity)	Get the user's notification preferences as json String
Set<String>	getPausedProjects(UserIdentity user)	Get the collection of paused project for a given user
Set<String>	getUserProjectsWithFrequency(User user, NotificationPreferencesHelper.Frequency frequency)	Get the user's project set to receive notification for given frequency
boolean	hasFrequencyInPreferences(User user, NotificationPreferencesHelper.Frequency frequency)	Determines if a user has at least one notification preference with the given frequency
void	service(ServiceManager manager)
boolean	setPauseProject(String projectName, boolean pause)	Change the pause status for the notifications of one project

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

USERPREFS_ID

public static final String USERPREFS_ID

the id of the user prefs for notification preferences

See Also:

• Constant Field Values

ROLE

public static final String ROLE

The avalon role

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_userPrefManager

protected UserPreferencesManager _userPrefManager

The user preferences manager

_userPrefEP

protected UserPreferencesExtensionPoint _userPrefEP

The user preferences extension point

_projectManager

protected ProjectManager _projectManager

The project manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

To get the current user

Constructor Details

NotificationPreferencesHelper

public NotificationPreferencesHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

askedToBeNotified

public boolean askedToBeNotified(User user,
 String projectName,
 NotificationPreferencesHelper.Frequency frequency)

Determines if a user asked to be notify for a given project and frequency

Parameters:

user - the user

projectName - the project name

frequency - the required frequency (each, daily, weekly or monthly)

Returns:

true if the user need to be notified

askedToBeNotified

public boolean askedToBeNotified(UserIdentity userIdentity,
 String projectName,
 NotificationPreferencesHelper.Frequency frequency)

Determines if a user asked to be notify for a given project and frequency

Parameters:

userIdentity - the user identity

projectName - the project name

frequency - the required frequency (each, daily, weekly or monthly). Cannot be null.

Returns:

true if the user need to be notified

getPausedProjects

public Set<String> getPausedProjects(UserIdentity user)

Get the collection of paused project for a given user

Parameters:

user - The user to consider

Returns:

The set of projects names that are paused or null for a general pause

setPauseProject

public boolean setPauseProject(String projectName,
 boolean pause)

Change the pause status for the notifications of one project

Parameters:

projectName - The project name to change

pause - The pause status

Returns:

true is the change was done successfully

hasFrequencyInPreferences

public boolean hasFrequencyInPreferences(User user,
 NotificationPreferencesHelper.Frequency frequency)

Determines if a user has at least one notification preference with the given frequency

Parameters:

user - the user

frequency - the frequency

Returns:

true if the user has at least one notification preference with the given frequency

getUserProjectsWithFrequency

public Set<String> getUserProjectsWithFrequency(User user,
 NotificationPreferencesHelper.Frequency frequency)

Get the user's project set to receive notification for given frequency

Parameters:

user - the user

frequency - the matching frequency

Returns:

The names of user's project's with same frequency

getNotificationPreferences

public Map<String,Object> getNotificationPreferences(User user)
                                              throws UserPreferencesException

Get the user's notification preferences

Parameters:

user - the user

Returns:

the user's notification preferences

Throws:

UserPreferencesException - if failed to retrieve user's preferences

getNotificationPreferences

public Map<String,Object> getNotificationPreferences(UserIdentity userIdentity)
                                              throws UserPreferencesException

Get the user's notification preferences

Parameters:

userIdentity - the user identity

Returns:

the user's notification preferences

Throws:

UserPreferencesException - if failed to retrieve user's preference

getNotificationPreferencesAsString

public String getNotificationPreferencesAsString(User user)
                                          throws UserPreferencesException

Get the user's notification preferences as json String

Parameters:

user - the user

Returns:

the user's notification preferences as json String

Throws:

UserPreferencesException - if failed to retrieve user's preference

getNotificationPreferencesAsString

public String getNotificationPreferencesAsString(UserIdentity userIdentity)
                                          throws UserPreferencesException

Get the user's notification preferences as json String

Parameters:

userIdentity - the user identity

Returns:

the user's notification preferences as json String

Throws:

UserPreferencesException - if failed to retrieve user's preference

deleteProjectNotificationPreferences

public void deleteProjectNotificationPreferences(UserIdentity userIdentity,
 String projectName)

Delete the user preferences for notification on the given project

Parameters:

userIdentity - the user identity

projectName - the name of the project to delete