Interface UpdateUser
- All Known Implementing Classes:
UpdateUserServlet
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 TypeMethodDescriptionorg.apache.jackrabbit.api.security.user.User
updateUser
(javax.jcr.Session jcrSession, String name, Map<String, ?> properties, List<Modification> changes) Update a user in the repository
-
Method Details
-
updateUser
org.apache.jackrabbit.api.security.user.User updateUser(javax.jcr.Session jcrSession, String name, Map<String, ?> properties, List<Modification> changes) throws javax.jcr.RepositoryExceptionUpdate a user in the repository- Parameters:
jcrSession
- the JCR session of the user updating the username
- 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
-