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 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 use
      userObject - 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 NuxeoException
      Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject
      Parameters:
      mappingName - the name of the contributed mapping to use
      userObject - the native userObject
      createIfNeeded - 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 NuxeoException
      Wrap the NuxeoPrincipal as the userObject used in the external authentication system *
      Parameters:
      mappingName - the name of the contributed mapping to use
      principal - the NuxeoPrincipal to wrap
      nativePrincipal - the principal Object in the target system (can be null)
      Throws:
      NuxeoException
    • getAvailableMappings

      Set<String> getAvailableMappings()
      Gives access to the contributed Mapping names
    • getMapper

      UserMapper getMapper(String mappingName) throws NuxeoException
      returns the named mapper is any
      Throws:
      NuxeoException