Package org.ametys.web.userpref

Class FOUserPreferencesDataProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.userpref.FOUserPreferencesDataProvider

All Implemented Interfaces:

UserDataProvider, LogEnabled, Prioritizable, Supporter<String>, Contextualizable, Serviceable

public class FOUserPreferencesDataProvider
extends AbstractLogEnabled
implements UserDataProvider, Serviceable, Contextualizable

A user data provider which gets the value from the user preferences associated with the User

Field Summary

Fields

Modifier and Type	Field	Description
protected UserPreferencesExtensionPoint	_userPrefEPFO	The user preferences extension point
protected UserPreferencesManager	_userPrefManagerFO	The user preferences manager

Fields inherited from interface org.ametys.core.user.dataprovider.UserDataProvider

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FOUserPreferencesDataProvider()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
int	getPriority()	Get the priority for the component.
Map<String,String>	getUserPreferences(UserIdentity userIdentity, String dataId)	Get the user preferences of a user
Object	getValue(User user, String dataId)	Get the value for a data and a user
void	service(ServiceManager serviceManager)
boolean	supports(String element)	Check if an element is supported

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

Methods inherited from interface org.ametys.core.user.dataprovider.UserDataProvider

hasValue

Field Details

_userPrefEPFO

protected UserPreferencesExtensionPoint _userPrefEPFO

The user preferences extension point

_userPrefManagerFO

protected UserPreferencesManager _userPrefManagerFO

The user preferences manager

Constructor Details

FOUserPreferencesDataProvider

public FOUserPreferencesDataProvider()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

supports

public boolean supports(String element)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<String>

Parameters:

element - The element

Returns:

true if the element is supported, false otherwise

getValue

public Object getValue(User user,
 String dataId)

Description copied from interface: UserDataProvider

Get the value for a data and a user

Specified by:

getValue in interface UserDataProvider

Parameters:

user - The User

dataId - The id of the data wanted

Returns:

The value of the data for the user, can be null

getUserPreferences

public Map<String,String> getUserPreferences(UserIdentity userIdentity,
 String dataId)
                                      throws UserPreferencesException

Get the user preferences of a user

Parameters:

userIdentity - The userIdentity of the User

dataId - The if of the data wanted

Returns:

The user preferences depending on the context

Throws:

UserPreferencesException - If an error occurs