Package org.ametys.plugins.mobileapp

Class UserPreferencesHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.mobileapp.UserPreferencesHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class UserPreferencesHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper to store/retreive conf per user

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__USERPREF_KEY_FEED_TYPES
private static String	__USERPREF_KEY_FEEDS
private static String	__USERPREF_KEY_LANG
private static String	__USERPREF_KEY_PROJECTS
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	JSON Utils
protected UserPreferencesManager	_userPreferencesManager	User Preferences Manager
static String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
UserPreferencesHelper()

Method Summary

Modifier and Type	Method	Description
void	addNotificationToken(String pushToken, String lang)	Add a notification token for the current user
void	addNotificationToken(String pushToken, String lang, UserIdentity user)	Add a notification token for a user
protected Map<String,Set<String>>	addTokenToMap(String token, List<String> feedIds, Map<String,Set<String>> existingMap)	Add a token in a map, with the feeds impacted
Map<String,Object>	getNotificationSettings(String pushToken, UserIdentity user)	Get the notification settings for a token
Set<String>	getNotificationTokens()	Get all notification tokens for current user
Set<String>	getNotificationTokens(UserIdentity user)	Get all notification tokens a user
Map<String,Set<String>>	getUserImpactedTokens(UserIdentity user, List<String> feedIds)	Get the list of impacted tokens for each feeds, for a user
Map<String,Set<String>>	getUserImpactedTokens(UserIdentity user, Project project, String eventType)	Get the list of impacted tokens for each feeds, for a user
void	removeAllNotificationTokens(UserIdentity user)	Remove all the notification tokens for a user
void	removeNotificationToken(String pushToken)	Removes a notification token for the current user
void	removeNotificationToken(String pushToken, UserIdentity user)	Removes a notification token for a user
void	service(ServiceManager manager)
void	setNotificationSettings(String pushToken, List<String> feeds, List<String> projects, List<String> types, String lang)	Save the notification settings for the current user
void	setNotificationSettings(String pushToken, List<String> feeds, List<String> projects, List<String> types, String lang, UserIdentity user)	Save the notification settings for a user

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 Detail

ROLE

public static final String ROLE

The avalon role.

__USERPREF_KEY_FEEDS

private static final String __USERPREF_KEY_FEEDS

See Also:

Constant Field Values

__USERPREF_KEY_PROJECTS

private static final String __USERPREF_KEY_PROJECTS

See Also:

Constant Field Values

__USERPREF_KEY_FEED_TYPES

private static final String __USERPREF_KEY_FEED_TYPES

See Also:

Constant Field Values

__USERPREF_KEY_LANG

private static final String __USERPREF_KEY_LANG

See Also:

Constant Field Values

_userPreferencesManager

protected UserPreferencesManager _userPreferencesManager

User Preferences Manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_jsonUtils

protected JSONUtils _jsonUtils

JSON Utils

Constructor Detail

UserPreferencesHelper

public UserPreferencesHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUserImpactedTokens

public Map<String,Set<String>> getUserImpactedTokens(UserIdentity user,
                                                           List<String> feedIds)

Get the list of impacted tokens for each feeds, for a user

Parameters:

user - user to check

feedIds - list of feeds to check

Returns:

a map with a Set of tokens for each feedId

getUserImpactedTokens

public Map<String,Set<String>> getUserImpactedTokens(UserIdentity user,
                                                           Project project,
                                                           String eventType)

Get the list of impacted tokens for each feeds, for a user

Parameters:

user - user to check

project - test if a notification should be sent for this project

eventType - test if a notification should be sent for this event type

Returns:

a map with a the set of tokens impacted for each languages

addTokenToMap

protected Map<String,Set<String>> addTokenToMap(String token,
                                                      List<String> feedIds,
                                                      Map<String,Set<String>> existingMap)

Add a token in a map, with the feeds impacted

Parameters:

token - the token to test

feedIds - the feeds impacted

existingMap - the existing map of feed -> set of tokens

Returns:

the map, with the token added

addNotificationToken

public void addNotificationToken(String pushToken,
                                 String lang)

Add a notification token for the current user

Parameters:

pushToken - the token to store

lang - lang of this device

addNotificationToken

public void addNotificationToken(String pushToken,
                                 String lang,
                                 UserIdentity user)

Add a notification token for a user

Parameters:

pushToken - the token to store

lang - lang of this device

user - the user impacted

getNotificationTokens

public Set<String> getNotificationTokens()

Get all notification tokens for current user

Returns:

the list of notification tokens

getNotificationTokens

public Set<String> getNotificationTokens(UserIdentity user)

Get all notification tokens a user

Parameters:

user - the user impacted

Returns:

the list of notification tokens

removeNotificationToken

public void removeNotificationToken(String pushToken)

Removes a notification token for the current user

Parameters:

pushToken - the token to remove

removeNotificationToken

public void removeNotificationToken(String pushToken,
                                    UserIdentity user)

Removes a notification token for a user

Parameters:

pushToken - the token to remove

user - the user impacted

removeAllNotificationTokens

public void removeAllNotificationTokens(UserIdentity user)

Remove all the notification tokens for a user

Parameters:

user - the user impacted

setNotificationSettings

public void setNotificationSettings(String pushToken,
                                    List<String> feeds,
                                    List<String> projects,
                                    List<String> types,
                                    String lang)

Save the notification settings for the current user

Parameters:

pushToken - the token to impact

feeds - list of feeds ID for notifications

projects - list of project ID for notifications

types - list of notifications types for notifications in projects

lang - lang of this device

setNotificationSettings

public void setNotificationSettings(String pushToken,
                                    List<String> feeds,
                                    List<String> projects,
                                    List<String> types,
                                    String lang,
                                    UserIdentity user)

Save the notification settings for a user

Parameters:

pushToken - token impacted by this settings

feeds - list of feeds ID for notifications

projects - list of project ID for notifications

types - list of notifications types for notifications in projects

lang - lang of this device

user - the user impacted

getNotificationSettings

public Map<String,Object> getNotificationSettings(String pushToken,
                                                        UserIdentity user)

Get the notification settings for a token

Parameters:

pushToken - the token to read

user - the user impacted

Returns:

a map containing feeds, projects and types as Set<String>, and epochDay as the last modification date