Renamed isEditable to mutable

James Moger

2012-10-31 40b07bca7d02438cd0d660f3b1713ffa86f6df76

 src/com/gitblit/IUserService.java

@@ -17,6 +17,7 @@


import java.util.List;



import com.gitblit.models.TeamModel;

import com.gitblit.models.UserModel;



/**

@@ -39,6 +40,38 @@
   void setup(IStoredSettings settings);



   /**

    * Does the user service support changes to credentials?

    * 
    * @return true or false

    * @since 1.0.0

    */	
   boolean supportsCredentialChanges();



   /**

    * Does the user service support changes to user display name?

    * 
    * @return true or false

    * @since 1.0.0

    */	
   boolean supportsDisplayNameChanges();



   /**

    * Does the user service support changes to user email address?

    * 
    * @return true or false

    * @since 1.0.0

    */	
   boolean supportsEmailAddressChanges();

	
   /**

    * Does the user service support changes to team memberships?

    * 
    * @return true or false

    * @since 1.0.0

    */	
   boolean supportsTeamMembershipChanges();

	
   /**

    * Does the user service support cookie authentication?

    * 

    * @return true or false

@@ -51,7 +84,7 @@
    * @param model

    * @return cookie value

    */

   char[] getCookie(UserModel model);

   String getCookie(UserModel model);



   /**

    * Authenticate a user based on their cookie.

@@ -71,6 +104,13 @@
   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

@@ -86,6 +126,15 @@
    */

   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(List<UserModel> models);

	
   /**

    * Adds/updates a user object keyed by username. This method allows for

    * renaming a user.

@@ -120,6 +169,112 @@
    * @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);



   /**

    * Sets the list of all teams who are allowed to bypass the access

    * restriction placed on the specified repository.

    * 
    * @param role

    *            the repository name

    * @param teamnames

    * @return true if successful

    * @since 0.8.0

    */

   @Deprecated

   boolean setTeamnamesForRepositoryRole(String role, List<String> teamnames);

	
   /**

    * 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(List<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

@@ -128,6 +283,7 @@
    * @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);



@@ -140,6 +296,7 @@
    * @param usernames

    * @return true if successful

    */

   @Deprecated

   boolean setUsernamesForRepositoryRole(String role, List<String> usernames);



   /**