Package org.nuxeo.usermapper.service
Interface UserMapperService
- All Known Implementing Classes:
UserMapperComponent
public interface UserMapperService
This service allows to map Nuxeo Users with users coming from external system like SSO or IDM.
- Since:
- 7.4
- Author:
- tiry
-
Method Summary
Modifier and TypeMethodDescriptionGives access to the contributed Mapping namesreturns the named mapper is anygetOrCreateAndUpdateNuxeoPrincipal
(String mappingName, Object userObject) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObjectgetOrCreateAndUpdateNuxeoPrincipal
(String mappingName, Object userObject, boolean createIfNeeded, boolean update, Map<String, Serializable> params) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObjectwrapNuxeoPrincipal
(String mappingName, NuxeoPrincipal principal, Object nativePrincipal, Map<String, Serializable> params) Wrap theNuxeoPrincipal
as the userObject used in the external authentication system *
-
Method Details
-
getOrCreateAndUpdateNuxeoPrincipal
NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(String mappingName, Object userObject) throws NuxeoException Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject- Parameters:
mappingName
- the name of the contributed mapping to useuserObject
- the native userObject- Returns:
- the matching
NuxeoPrincipal
- Throws:
NuxeoException
-
getOrCreateAndUpdateNuxeoPrincipal
NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(String mappingName, Object userObject, boolean createIfNeeded, boolean update, Map<String, Serializable> params) throws NuxeoExceptionShould retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject- Parameters:
mappingName
- the name of the contributed mapping to useuserObject
- the native userObjectcreateIfNeeded
- flag to allow creation (default is true)update
- flag to run update (default is true)- Returns:
- the matching
NuxeoPrincipal
- Throws:
NuxeoException
-
wrapNuxeoPrincipal
Object wrapNuxeoPrincipal(String mappingName, NuxeoPrincipal principal, Object nativePrincipal, Map<String, Serializable> params) throws NuxeoExceptionWrap theNuxeoPrincipal
as the userObject used in the external authentication system *- Parameters:
mappingName
- the name of the contributed mapping to useprincipal
- theNuxeoPrincipal
to wrapnativePrincipal
- the principal Object in the target system (can be null)- Throws:
NuxeoException
-
getAvailableMappings
Gives access to the contributed Mapping names -
getMapper
returns the named mapper is any- Throws:
NuxeoException
-