org.nuxeo.ecm.platform.ui.web.keycloak

Class KeycloakUserMapper

java.lang.Object

org.nuxeo.ecm.platform.ui.web.keycloak.KeycloakUserMapper

All Implemented Interfaces:

UserMapper

public class KeycloakUserMapper
extends Object
implements UserMapper

Plugin for the UserMapper to manage mapping between Ketcloack user and Nuxeo counterpart

Since:

7.4

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	groupSchemaName
protected UserManager	userManager
protected static String	userSchemaName

Constructor Summary

Constructors

Constructor and Description
KeycloakUserMapper()

Method Summary

Modifier and Type	Method and Description
NuxeoPrincipal	getOrCreateAndUpdateNuxeoPrincipal(Object userObject) Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject
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
void	init(Map<String,String> params) Init callback to receive the parameters set inside the descriptor
void	release() Release callback : called when the plugin is about to be unloaded
Object	wrapNuxeoPrincipal(NuxeoPrincipal principal, Object nativePrincipal, Map<String,Serializable> params) Wrap the NuxeoPrincipal as the userObject used in the external authentication system

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userSchemaName

protected static String userSchemaName

groupSchemaName

protected static String groupSchemaName

userManager

protected UserManager userManager

Constructor Detail

KeycloakUserMapper

public KeycloakUserMapper()

Method Detail

getOrCreateAndUpdateNuxeoPrincipal

public NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(Object userObject)

Description copied from interface: UserMapper

Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject

Specified by:

getOrCreateAndUpdateNuxeoPrincipal in interface UserMapper

Parameters:

userObject - the object representing the user in the external system

getOrCreateAndUpdateNuxeoPrincipal

public NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(Object userObject,
                                                         boolean createIfNeeded,
                                                         boolean update,
                                                         Map<String,Serializable> params)

Description copied from interface: UserMapper

Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject

Specified by:

getOrCreateAndUpdateNuxeoPrincipal in interface UserMapper

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)

init

public void init(Map<String,String> params)
          throws Exception

Description copied from interface: UserMapper

Init callback to receive the parameters set inside the descriptor

Specified by:

init in interface UserMapper

Throws:

Exception

wrapNuxeoPrincipal

public Object wrapNuxeoPrincipal(NuxeoPrincipal principal,
                                 Object nativePrincipal,
                                 Map<String,Serializable> params)

Description copied from interface: UserMapper

Wrap the NuxeoPrincipal as the userObject used in the external authentication system

Specified by:

wrapNuxeoPrincipal in interface UserMapper

Parameters:

principal - the NuxeoPrincipal

nativePrincipal - the native object to represent the principal in the target system

release

public void release()

Description copied from interface: UserMapper

Release callback : called when the plugin is about to be unloaded

Specified by:

release in interface UserMapper