com.communote.server.service

Class UserPreferenceService

java.lang.Object

com.communote.server.service.UserPreferenceService

@Service
public class UserPreferenceService
extends Object

Service for providing user preferences.

Author:

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

Constructor Summary

Constructors

Constructor and Description
UserPreferenceService()

Method Summary

Modifier and Type	Method and Description
<T extends UserPreference> T	getPreferences(Class<T> preferencesType) Method to load the given preferences for the current user.
UserPreference	getPreferences(String className) Method to load the given preferences for the current user.
String	getPreferencesAsJson()
<T extends UserPreference> String	getPreferencesAsJson(Class<T> preferencesType) Method to load the given preferences for the current user.
<T extends UserPreference> String	getPreferencesAsJson(String className) Method to load the given preferences for the current user.
void	initialize() Initializer method.
void	mergePreferences(String className, Map<String,String> preferences) This method can be used to merge the given properties with already existing data.
<T extends UserPreference> void	register(Class<T> preferencesType) Register a new preference type to allow storing and loading of preferences of this type.
<T extends UserPreference> void	removePreferences(Class<T> preferencesType) Method to remove all values for the given preferences type from the current user.
void	storePreferences(UserPreference preferences) Persists the given preferences.
<T extends UserPreference> void	unregister(Class<T> preferencesType) Method to unregister the type.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPreferenceService

public UserPreferenceService()

Method Detail

getPreferences

public <T extends UserPreference> T getPreferences(Class<T> preferencesType)
                                            throws AuthorizationException

Method to load the given preferences for the current user.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

preferencesType - Type of the preferences to load.

Returns:

The preferences. This will never return null.

Throws:

AuthorizationException - Thrown, when the current user does not have access to the given preferences.

getPreferences

public UserPreference getPreferences(String className)
                              throws AuthorizationException

Method to load the given preferences for the current user.

Parameters:

className - Full qualified class name of the preferences.

Returns:

The preferences. This will never return null.

Throws:

AuthorizationException - Thrown, when the current user does not have access to the given preferences.

getPreferencesAsJson

public String getPreferencesAsJson()

Returns:

all stored preferences of the current user as JSON object. The JSON object will be empty if there are no preferences

getPreferencesAsJson

public <T extends UserPreference> String getPreferencesAsJson(Class<T> preferencesType)
                                                       throws AuthorizationException

Method to load the given preferences for the current user.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

preferencesType - Type of the preferences to load.

Returns:

The preferences in JSON format.

Throws:

AuthorizationException - Thrown, when the current user does not have access to the given preferences.

getPreferencesAsJson

public <T extends UserPreference> String getPreferencesAsJson(String className)
                                                       throws AuthorizationException

Method to load the given preferences for the current user.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

className - Full qualified class name of the preferences.

Returns:

The preferences in JSON format.

Throws:

AuthorizationException - Thrown, when the current user does not have access to the given preferences.

initialize

@PostConstruct
public void initialize()

Initializer method.

mergePreferences

public void mergePreferences(String className,
                             Map<String,String> preferences)
                      throws NotFoundException,
                             AuthorizationException

This method can be used to merge the given properties with already existing data.

Parameters:

className - Full qualified class name of the preferences.

preferences - The preferences to merge.

Throws:

NotFoundException - Thrown, when there is not type for the given class name registered.

AuthorizationException - Thrown, when the current user doesn't have access to the preferences.

register

public <T extends UserPreference> void register(Class<T> preferencesType)

Register a new preference type to allow storing and loading of preferences of this type.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

preferencesType - The type to register.

removePreferences

public <T extends UserPreference> void removePreferences(Class<T> preferencesType)
                                                  throws AuthorizationException

Method to remove all values for the given preferences type from the current user.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

preferencesType - The preference type.

Throws:

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

storePreferences

public void storePreferences(UserPreference preferences)

Persists the given preferences.

Parameters:

preferences - The preferences to persist.

unregister

public <T extends UserPreference> void unregister(Class<T> preferencesType)

Method to unregister the type. This should be explicitly called, when a type shall be removed.

Type Parameters:

T - Concrete type of the user preference.

Parameters:

preferencesType - The type to remove.