org.apache.sling.jackrabbit.usermanager.UpdateUser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.jcr.jackrabbit.usermanager Show documentation

Provides ResourceProvider and POST operations for the Jackrabbit User Manager.

There is a newer version: 2.2.30

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.sling.jackrabbit.usermanager;

import java.util.List;
import java.util.Map;

import javax.jcr.RepositoryException;
import javax.jcr.Session;

import org.apache.jackrabbit.api.security.user.User;
import org.apache.sling.servlets.post.Modification;

/**
 * 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
 */
public interface UpdateUser {

    /**
     * Update a user in the repository
     * 
     * @param jcrSession the JCR session of the user updating the user
     * @param name The name of the user to update (required)
     * @param properties Extra properties to update on the user. The entry values should be either a String or String[] (optional)
     * @param changes The list of changes for this operation (optional)
     * @return the user that was updated or null if not found 
     * @throws RepositoryException
     */
    public User updateUser(Session jcrSession,
                            String name,
                            Map properties,
                            List changes
                ) throws RepositoryException;
    
}