org.apache.sling.jackrabbit.usermanager

Interface UpdateUser

public interface UpdateUser

The UpdateUser service api.

This interface is not intended to be implemented by bundles. It is implemented by this bundle and may be used by client bundles.

Since:

2.2.0

Method Summary

Modifier and Type	Method and Description
org.apache.jackrabbit.api.security.user.User	updateUser(javax.jcr.Session jcrSession, java.lang.String name, java.util.Map<java.lang.String,?> properties, java.util.List<Modification> changes) Update a user in the repository

Method Detail

updateUser

org.apache.jackrabbit.api.security.user.User updateUser(javax.jcr.Session jcrSession,
                                                        java.lang.String name,
                                                        java.util.Map<java.lang.String,?> properties,
                                                        java.util.List<Modification> changes)
                                                 throws javax.jcr.RepositoryException

Update a user in the repository

Parameters:

jcrSession - the JCR session of the user updating the user

name - The name of the user to update (required)

properties - Extra properties to update on the user. The entry values should be either a String or String[] (optional)

changes - The list of changes for this operation (optional)

Returns:

the user that was updated or null if not found

Throws:

javax.jcr.RepositoryException - if user can't be updated