Package org.ametys.core.user.dataprovider

Class UserDataProviderExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<UserDataProvider>

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentPrioritizableExtensionPoint<UserDataProvider>

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentPrioritizableSupporterExtensionPoint<UserDataProvider,String>

org.ametys.core.user.dataprovider.UserDataProviderExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<UserDataProvider>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class UserDataProviderExtensionPoint
extends AbstractThreadSafeComponentPrioritizableSupporterExtensionPoint<UserDataProvider,String>

Extension point for retrieving user data

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
UserDataProviderExtensionPoint()

Method Summary

Modifier and Type	Method	Description
UserDataProvider	getProviderFor(User user, String dataId)	Get the provider for the data and the user
Object	getValue(UserIdentity userIdentity, String dataId)	Get the value of the data for the user
Object	getValue(User user, String dataId)	Get the value of the data for the user
void	service(ServiceManager manager)

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

_getSupportingExtensions, getFirstSupportingExtension, getSupportingExtensions

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

getComparator, getExtensionsIds, initializeExtensions, sortPriorityAscending

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

addComponent, addExtension, contextualize, dispose, getExtension, hasExtension, initialize

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

ROLE

public static final String ROLE

The role

Constructor Details

UserDataProviderExtensionPoint

public UserDataProviderExtensionPoint()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractThreadSafeComponentExtensionPoint<UserDataProvider>

Throws:

ServiceException

getValue

public Object getValue(User user,
 String dataId)

Get the value of the data for the user

Parameters:

user - The user, can be null

dataId - The id of the wanted data

Returns:

The value of the data or null if there is no value or if the user given is null

getValue

public Object getValue(UserIdentity userIdentity,
 String dataId)

Get the value of the data for the user

Parameters:

userIdentity - The user identity, can be null

dataId - The id of the wanted data

Returns:

The value of the data or null if there is no value or if the user given is null

getProviderFor

public UserDataProvider getProviderFor(User user,
 String dataId)

Get the provider for the data and the user

Parameters:

user - The user

dataId - The data wanted

Returns:

The UserDataProvider that is going to provide the data