Package org.ametys.core.userpref

Class UserPreferencesDataProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.userpref.UserPreferencesDataProvider

All Implemented Interfaces:

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

public class UserPreferencesDataProvider
extends AbstractLogEnabled
implements UserDataProvider, Serviceable

A user data provider which gets the value from the global user preferences associated with the User for context admin

Field Summary

Fields

Modifier and Type	Field	Description
protected ProfileImageProvider	_imageProvider	The Default profile image provider
protected JSONUtils	_jsonUtils	The json utils
protected static List<String>	_supportedElements	The supported elements
protected UserPreferencesExtensionPoint	_userPrefEP	The user preferences extension point
protected UserPreferencesManager	_userPrefManager	The user preferences manager
static final String	USER_PREFERENCES_DATA_PROVIDER_ID	The ID of this data provider

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
UserPreferencesDataProvider()

Method Summary

Modifier and Type	Method	Description
int	getPriority()	Get the priority for the component.
DefaultProfileImageProvider.ProfileImageSource	getProfileImageSource(String imageSourceStr)	Get the profile image source given a source input string
Object	getValue(User user, String dataId)	Get the value for a data and a user
void	service(ServiceManager manager)
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

USER_PREFERENCES_DATA_PROVIDER_ID

public static final String USER_PREFERENCES_DATA_PROVIDER_ID

The ID of this data provider

_supportedElements

protected static List<String> _supportedElements

The supported elements

_userPrefEP

protected UserPreferencesExtensionPoint _userPrefEP

The user preferences extension point

_userPrefManager

protected UserPreferencesManager _userPrefManager

The user preferences manager

_imageProvider

protected ProfileImageProvider _imageProvider

The Default profile image provider

_jsonUtils

protected JSONUtils _jsonUtils

The json utils

Constructor Details

UserPreferencesDataProvider

public UserPreferencesDataProvider()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

getProfileImageSource

public DefaultProfileImageProvider.ProfileImageSource getProfileImageSource(String imageSourceStr)

Get the profile image source given a source input string

Parameters:

imageSourceStr - The input string representing the source

Returns:

The profile image source.