Package org.nuxeo.usermapper.extension
Interface UserMapper
- All Known Implementing Classes:
AbstractUserMapper
,GroovyUserMapper
,KeycloakUserMapper
,NashornUserMapper
public interface UserMapper
Interface for class providing a named implementation for the
UserMapperService
- Since:
- 7.4
- Author:
- tiry
-
Method Summary
Modifier and TypeMethodDescriptiongetOrCreateAndUpdateNuxeoPrincipal
(Object userObject) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObjectgetOrCreateAndUpdateNuxeoPrincipal
(Object userObject, boolean createIfNeeded, boolean update, Map<String, Serializable> params) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObjectvoid
Init callback to receive the parameters set inside the descriptorvoid
release()
Release callback : called when the plugin is about to be unloadedwrapNuxeoPrincipal
(NuxeoPrincipal principal, Object nativePrincipal, Map<String, Serializable> params) Wrap theNuxeoPrincipal
as the userObject used in the external authentication system
-
Method Details
-
getOrCreateAndUpdateNuxeoPrincipal
Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject- Parameters:
userObject
- the object representing the user in the external system
-
getOrCreateAndUpdateNuxeoPrincipal
NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(Object userObject, boolean createIfNeeded, boolean update, Map<String, Serializable> params) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject- Parameters:
userObject
- the object representing the user in the external systemcreateIfNeeded
- flag to allow creation (default is true)update
- flag to run update (default is true)
-
wrapNuxeoPrincipal
Object wrapNuxeoPrincipal(NuxeoPrincipal principal, Object nativePrincipal, Map<String, Serializable> params) Wrap theNuxeoPrincipal
as the userObject used in the external authentication system- Parameters:
principal
- the NuxeoPrincipalnativePrincipal
- the native object to represent the principal in the target system
-
init
Init callback to receive the parameters set inside the descriptor- Throws:
Exception
-
release
void release()Release callback : called when the plugin is about to be unloaded
-