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 Details

    • getOrCreateAndUpdateNuxeoPrincipal

      NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(Object userObject)
      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 system
      createIfNeeded - 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 the NuxeoPrincipal as the userObject used in the external authentication system
      Parameters:
      principal - the NuxeoPrincipal
      nativePrincipal - the native object to represent the principal in the target system
    • init

      void init(Map<String,String> params) throws Exception
      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