Merge pull request #1073 from gitblit/1062-DocEditorUpdates

Paul Martin

2016-04-30 a502d96a860456ec5e8c96761db70f7cabb74751

 src/main/java/com/gitblit/manager/IUserManager.java

@@ -15,266 +15,17 @@
 */
package com.gitblit.manager;

import java.util.Collection;
import java.util.List;
import com.gitblit.IUserService;

import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;

public interface IUserManager extends IManager {

   boolean supportsAddUser();
public interface IUserManager extends IManager, IUserService {

   /**
    * Does the user service support changes to credentials?
    *
    * @return true or false
    * @since 1.0.0
    */
   boolean supportsCredentialChanges(UserModel user);

   /**
    * Returns true if the user's display name can be changed.
    *
    * @param user
    * @return true if the user service supports display name changes
    */
   boolean supportsDisplayNameChanges(UserModel user);

   /**
    * Returns true if the user's email address can be changed.
    *
    * @param user
    * @return true if the user service supports email address changes
    */
   boolean supportsEmailAddressChanges(UserModel user);

   /**
    * Returns true if the user's team memberships can be changed.
    *
    * @param user
    * @return true if the user service supports team membership changes
    */
   boolean supportsTeamMembershipChanges(UserModel user);

   /**
    * Does the user service support cookie authentication?
    *
    * @return true or false
    */
   boolean supportsCookies();

   /**
    * Returns the cookie value for the specified user.
    *
    * @param model
    * @return cookie value
    */
   String getCookie(UserModel model);

   /**
    * Authenticate a user based on their cookie.
    *
    * @param cookie
    * @return a user object or null
    */
   UserModel authenticate(char[] cookie);

   /**
    * Authenticate a user based on a username and password.
    * Returns true if the username represents an internal account
    *
    * @param username
    * @param password
    * @return a user object or null
    * @return true if the specified username represents an internal account
     * @since 1.4.0
    */
   UserModel authenticate(String username, char[] password);

   /**
    * Logout a user.
    *
    * @param user
    */
   void logout(UserModel user);

   /**
    * Retrieve the user object for the specified username.
    *
    * @param username
    * @return a user object or null
    */
   UserModel getUserModel(String username);

   /**
    * Updates/writes a complete user object.
    *
    * @param model
    * @return true if update is successful
    */
   boolean updateUserModel(UserModel model);

   /**
    * Updates/writes all specified user objects.
    *
    * @param models a list of user models
    * @return true if update is successful
    * @since 1.2.0
    */
   boolean updateUserModels(Collection<UserModel> models);

   /**
    * Adds/updates a user object keyed by username. This method allows for
    * renaming a user.
    *
    * @param username
    *            the old username
    * @param model
    *            the user object to use for username
    * @return true if update is successful
    */
   boolean updateUserModel(String username, UserModel model);

   /**
    * Deletes the user object from the user service.
    *
    * @param model
    * @return true if successful
    */
   boolean deleteUserModel(UserModel model);

   /**
    * Delete the user object with the specified username
    *
    * @param username
    * @return true if successful
    */
   boolean deleteUser(String username);

   /**
    * Returns the list of all users available to the login service.
    *
    * @return list of all usernames
    */
   List<String> getAllUsernames();

   /**
    * Returns the list of all users available to the login service.
    *
    * @return list of all users
    * @since 0.8.0
    */
   List<UserModel> getAllUsers();

   /**
    * Returns the list of all teams available to the login service.
    *
    * @return list of all teams
    * @since 0.8.0
    */
   List<String> getAllTeamNames();

   /**
    * Returns the list of all teams available to the login service.
    *
    * @return list of all teams
    * @since 0.8.0
    */
   List<TeamModel> getAllTeams();

   /**
    * Returns the list of all users who are allowed to bypass the access
    * restriction placed on the specified repository.
    *
    * @param role
    *            the repository name
    * @return list of all usernames that can bypass the access restriction
    * @since 0.8.0
    */
   List<String> getTeamNamesForRepositoryRole(String role);

   /**
    * Retrieve the team object for the specified team name.
    *
    * @param teamname
    * @return a team object or null
    * @since 0.8.0
    */
   TeamModel getTeamModel(String teamname);

   /**
    * Updates/writes a complete team object.
    *
    * @param model
    * @return true if update is successful
    * @since 0.8.0
    */
   boolean updateTeamModel(TeamModel model);

   /**
    * Updates/writes all specified team objects.
    *
    * @param models a list of team models
    * @return true if update is successful
    * @since 1.2.0
    */
   boolean updateTeamModels(Collection<TeamModel> models);

   /**
    * Updates/writes and replaces a complete team object keyed by teamname.
    * This method allows for renaming a team.
    *
    * @param teamname
    *            the old teamname
    * @param model
    *            the team object to use for teamname
    * @return true if update is successful
    * @since 0.8.0
    */
   boolean updateTeamModel(String teamname, TeamModel model);

   /**
    * Deletes the team object from the user service.
    *
    * @param model
    * @return true if successful
    * @since 0.8.0
    */
   boolean deleteTeamModel(TeamModel model);

   /**
    * Delete the team object with the specified teamname
    *
    * @param teamname
    * @return true if successful
    * @since 0.8.0
    */
   boolean deleteTeam(String teamname);

   /**
    * Returns the list of all users who are allowed to bypass the access
    * restriction placed on the specified repository.
    *
    * @param role
    *            the repository name
    * @return list of all usernames that can bypass the access restriction
    * @since 0.8.0
    */
   List<String> getUsernamesForRepositoryRole(String role);

   /**
    * Renames a repository role.
    *
    * @param oldRole
    * @param newRole
    * @return true if successful
    */
   boolean renameRepositoryRole(String oldRole, String newRole);

   /**
    * Removes a repository role from all users.
    *
    * @param role
    * @return true if successful
    */
   boolean deleteRepositoryRole(String role);
   boolean isInternalAccount(String username);

}