Package org.nuxeo.usermapper.service

Class UserMapperComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.usermapper.service.UserMapperComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService, UserMapperService

public class UserMapperComponent
extends DefaultComponent
implements UserMapperService

Component to manage extension point and expose the UserMapperService interface.

Since:

7.4

Author:

tiry

Field Summary

Fields

Modifier and Type	Field	Description
protected List<UserMapperDescriptor>	descriptors
static final String	MAPPER_EP
protected Map<String,UserMapper>	mappers

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
UserMapperComponent()

Method Summary

Modifier and Type	Method	Description
void	deactivate(ComponentContext context)	Deactivates the component.
Set<String>	getAvailableMappings()	Gives access to the contributed Mapping names
UserMapper	getMapper(String mappingName)	returns the named mapper is any
NuxeoPrincipal	getOrCreateAndUpdateNuxeoPrincipal(String mappingName, Object userObject)	Should retrieve (create if needed) and update the NuxeoPrincipal according to the given userObject
NuxeoPrincipal	getOrCreateAndUpdateNuxeoPrincipal(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 userObject
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	start(ComponentContext context)	Start the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
Object	wrapNuxeoPrincipal(String mappingName, NuxeoPrincipal principal, Object nativePrincipal, Map<String,Serializable> params)	Wrap the NuxeoPrincipal as the userObject used in the external authentication system *

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, stop, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

mappers

protected Map<String,UserMapper> mappers

descriptors

protected List<UserMapperDescriptor> descriptors

MAPPER_EP

public static final String MAPPER_EP

See Also:

• Constant Field Values

Constructor Details

UserMapperComponent

public UserMapperComponent()

Method Details

registerContribution

public void registerContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

getMapper

public UserMapper getMapper(String mappingName)
                     throws NuxeoException

Description copied from interface: UserMapperService

returns the named mapper is any

Specified by:

getMapper in interface UserMapperService

Throws:

NuxeoException

getOrCreateAndUpdateNuxeoPrincipal

public NuxeoPrincipal getOrCreateAndUpdateNuxeoPrincipal(String mappingName,
 Object userObject)
                                                  throws NuxeoException

Description copied from interface: UserMapperService

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

Specified by:

getOrCreateAndUpdateNuxeoPrincipal in interface UserMapperService

Parameters:

mappingName - the name of the contributed mapping to use

userObject - the native userObject

Returns:

the matching NuxeoPrincipal

Throws:

NuxeoException

getOrCreateAndUpdateNuxeoPrincipal

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

Description copied from interface: UserMapperService

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

Specified by:

getOrCreateAndUpdateNuxeoPrincipal in interface UserMapperService

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

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

Description copied from interface: UserMapperService

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

Specified by:

wrapNuxeoPrincipal in interface UserMapperService

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

public Set<String> getAvailableMappings()

Description copied from interface: UserMapperService

Gives access to the contributed Mapping names

Specified by:

getAvailableMappings in interface UserMapperService