Updated documentation

James Moger

2013-01-05 9e186eedf1a09ca7ac4fbdea32b00e7e5331f7eb

 src/com/gitblit/GitblitUserService.java

@@ -23,9 +23,11 @@
import org.slf4j.Logger;

import org.slf4j.LoggerFactory;



import com.gitblit.Constants.AccountType;

import com.gitblit.models.TeamModel;

import com.gitblit.models.UserModel;

import com.gitblit.utils.DeepCopier;

import com.gitblit.utils.StringUtils;



/**

 * This class wraps the default user service and is recommended as the starting

@@ -48,6 +50,8 @@
public class GitblitUserService implements IUserService {



   protected IUserService serviceImpl;

	
   protected final String ExternalAccount = "#externalAccount";



   private final Logger logger = LoggerFactory.getLogger(GitblitUserService.class);



@@ -118,6 +122,16 @@
   }



   @Override

   public boolean supportsDisplayNameChanges() {

      return serviceImpl.supportsDisplayNameChanges();

   }



   @Override

   public boolean supportsEmailAddressChanges() {

      return serviceImpl.supportsEmailAddressChanges();

   }



   @Override

   public boolean supportsTeamMembershipChanges() {

      return serviceImpl.supportsTeamMembershipChanges();

   }

@@ -128,23 +142,34 @@
   }



   @Override

   public char[] getCookie(UserModel model) {

   public String getCookie(UserModel model) {

      return serviceImpl.getCookie(model);

   }



   @Override

   public UserModel authenticate(char[] cookie) {

      return serviceImpl.authenticate(cookie);

      UserModel user = serviceImpl.authenticate(cookie);

      setAccountType(user);

      return user;

   }



   @Override

   public UserModel authenticate(String username, char[] password) {

      return serviceImpl.authenticate(username, password);

      UserModel user = serviceImpl.authenticate(username, password);

      setAccountType(user);

      return user;

   }

	
   @Override

   public void logout(UserModel user) {

      serviceImpl.logout(user);

   }



   @Override

   public UserModel getUserModel(String username) {

      return serviceImpl.getUserModel(username);

      UserModel user = serviceImpl.getUserModel(username);

      setAccountType(user);

      return user;

   }



   @Override

@@ -153,9 +178,14 @@
   }



   @Override

   public boolean updateUserModels(List<UserModel> models) {

      return serviceImpl.updateUserModels(models);

   }



   @Override

   public boolean updateUserModel(String username, UserModel model) {

      if (supportsCredentialChanges()) {

         if (!supportsTeamMembershipChanges()) {

      if (model.isLocalAccount() || supportsCredentialChanges()) {

         if (!model.isLocalAccount() && !supportsTeamMembershipChanges()) {

            //  teams are externally controlled - copy from original model

            UserModel existingModel = getUserModel(username);

            

@@ -168,7 +198,7 @@
      if (model.username.equals(username)) {

         // passwords are not persisted by the backing user service

         model.password = null;

         if (!supportsTeamMembershipChanges()) {

         if (!model.isLocalAccount() && !supportsTeamMembershipChanges()) {

            //  teams are externally controlled- copy from original model

            UserModel existingModel = getUserModel(username);

            

@@ -198,7 +228,11 @@


   @Override

   public List<UserModel> getAllUsers() {

      return serviceImpl.getAllUsers();

      List<UserModel> users = serviceImpl.getAllUsers();

       for (UserModel user : users) {

          setAccountType(user);

       }

      return users; 
   }



   @Override

@@ -217,6 +251,7 @@
   }



   @Override

   @Deprecated

   public boolean setTeamnamesForRepositoryRole(String role, List<String> teamnames) {

      return serviceImpl.setTeamnamesForRepositoryRole(role, teamnames);

   }

@@ -229,6 +264,11 @@
   @Override

   public boolean updateTeamModel(TeamModel model) {

      return serviceImpl.updateTeamModel(model);

   }



   @Override

   public boolean updateTeamModels(List<TeamModel> models) {

      return serviceImpl.updateTeamModels(models);

   }



   @Override

@@ -260,6 +300,7 @@
   }



   @Override

   @Deprecated

   public boolean setUsernamesForRepositoryRole(String role, List<String> usernames) {

      return serviceImpl.setUsernamesForRepositoryRole(role, usernames);

   }

@@ -273,4 +314,25 @@
   public boolean deleteRepositoryRole(String role) {

      return serviceImpl.deleteRepositoryRole(role);

   }

	
   protected boolean isLocalAccount(String username) {

      UserModel user = getUserModel(username);

      return user != null && user.isLocalAccount();

   }

	
   protected void setAccountType(UserModel user) {

      if (user != null) {

         if (!StringUtils.isEmpty(user.password)

               && !ExternalAccount.equalsIgnoreCase(user.password)

               && !"StoredInLDAP".equalsIgnoreCase(user.password)) {

            user.accountType = AccountType.LOCAL;

         } else {

            user.accountType = getAccountType();

         }

      }

   }

	
   protected AccountType getAccountType() {

      return AccountType.LOCAL;

   }

}