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

Go to download
/*
 * 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 CreateUser 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 CreateUser {

    /**
     * Create a new user for the repository
     * 
     * @param jcrSession the JCR session of the user creating the user
     * @param name The name of the new user.  If null or empty, the name is calculated from the supplied properties (per SLING-10902).
     * @param password The password of the new user (required)
     * @param passwordConfirm The password of the new user again (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 created
     * @throws RepositoryException if user can't be created
     */
    public User createUser(Session jcrSession,
                            String name,
                            String password,
                            String passwordConfirm,
                            Map properties,
                            List changes
                ) throws RepositoryException;

    /**
     * Create a new user for the repository. The name is calculated from the 
     * supplied properties (per SLING-10902).
     * 
     * @param jcrSession the JCR session of the user creating the user
     * @param password The password of the new user (required)
     * @param passwordConfirm The password of the new user again (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 created
     * @throws RepositoryException if user can't be created
     */
    public default User createUser(Session jcrSession,
                            String password,
                            String passwordConfirm,
                            Map properties,
                            List changes
                ) throws RepositoryException {
        return createUser(jcrSession, null, password, passwordConfirm, properties, changes);
    }
}