Add repository and user/team lifecycle listener extension points

James Moger

2014-06-09 ca4d98678c20e4033fdaca09ecbbf0f5952e0b84

 src/main/java/com/gitblit/IUserService.java

@@ -18,7 +18,6 @@
import java.util.Collection;

import java.util.List;



import com.gitblit.Constants.AccountType;

import com.gitblit.manager.IRuntimeManager;

import com.gitblit.models.TeamModel;

import com.gitblit.models.UserModel;

@@ -43,81 +42,29 @@
   void setup(IRuntimeManager runtimeManager);



   /**

    * 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

    */

   boolean supportsCookies();



   /**

    * Returns the cookie value for the specified user.

    *

    * @param model

    * @return cookie value

     * @since 0.5.0

    */

   String getCookie(UserModel model);



   /**

    * Authenticate a user based on their cookie.

    * Retrieve a user object for the specified cookie.

    *

    * @param cookie

    * @return a user object or null

     * @since 0.5.0

    */

   UserModel authenticate(char[] cookie);



   /**

    * Authenticate a user based on a username and password.

    *

    * @param username

    * @param password

    * @return a user object or null

    */

   UserModel authenticate(String username, char[] password);



   /**

    * Logout a user.

    *

    * @param user

    */

   void logout(UserModel user);

   UserModel getUserModel(char[] cookie);



   /**

    * Retrieve the user object for the specified username.

    *

    * @param username

    * @return a user object or null

     * @since 0.5.0

    */

   UserModel getUserModel(String username);



@@ -126,6 +73,7 @@
    *

    * @param model

    * @return true if update is successful

     * @since 0.5.0

    */

   boolean updateUserModel(UserModel model);



@@ -147,6 +95,7 @@
    * @param model

    *            the user object to use for username

    * @return true if update is successful

     * @since 0.5.0

    */

   boolean updateUserModel(String username, UserModel model);



@@ -155,6 +104,7 @@
    *

    * @param model

    * @return true if successful

     * @since 0.5.0

    */

   boolean deleteUserModel(UserModel model);



@@ -163,6 +113,7 @@
    *

    * @param username

    * @return true if successful

     * @since 0.5.0

    */

   boolean deleteUser(String username);



@@ -170,6 +121,7 @@
    * Returns the list of all users available to the login service.

    *

    * @return list of all usernames

     * @since 0.5.0

    */

   List<String> getAllUsernames();



@@ -207,19 +159,6 @@
    * @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.

@@ -291,23 +230,12 @@
   List<String> getUsernamesForRepositoryRole(String role);



   /**

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

    * restriction placed on the specified repository.

    *

    * @param role

    *            the repository name

    * @param usernames

    * @return true if successful

    */

   @Deprecated

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



   /**

    * Renames a repository role.

    *

    * @param oldRole

    * @param newRole

    * @return true if successful

     * @since 0.5.0

    */

   boolean renameRepositoryRole(String oldRole, String newRole);



@@ -316,16 +244,9 @@
    *

    * @param role

    * @return true if successful

     * @since 0.5.0

    */

   boolean deleteRepositoryRole(String role);



   /**

    * Returns the account type for the user models.

    *

    * @return the account type

    * @since 1.4.0

    */

   AccountType getAccountType();



   /**

    * @See java.lang.Object.toString();