/**
 * Copyright (c) 2010, Sebastian Sdorra
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of SCM-Manager; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */



package sonia.scm.user;

//~--- non-JDK imports --------------------------------------------------------

import sonia.scm.Manager;
import sonia.scm.search.Searchable;

import java.util.Collection;

/**
 * The central class for managing {@link User} objects.
 * This class is a singleton and is available via injection.
 * 
 * @author Sebastian Sdorra
 */
public interface UserManager
        extends Manager<User>, Searchable<User>
{

  /**
   * Returns true if a user with the specified username exists.
   *
   *
   * @param username username of the user
   *
   * @return true if the user exists
   */
  public boolean contains(String username);

  //~--- get methods ----------------------------------------------------------

  /**
   * Returns the default type for users.
   *
   *
   * @return default user type
   * @since 1.14
   */
  public String getDefaultType();

  default boolean isTypeDefault(User user) {
    return getDefaultType().equals(user.getType());
  }

  /**
   * Changes the password of the logged in user.
   * @param oldPassword The current encrypted password of the user.
   * @param newPassword The new encrypted password of the user.
   */
  void changePasswordForLoggedInUser(String oldPassword, String newPassword);

  /**
   * Overwrites the password for the given user id. This needs user write privileges.
   * @param userId The id of the user to change the password for.
   * @param newPassword The new encrypted password.
   */
  void overwritePassword(String userId, String newPassword);
}
