Documentation

James Moger

2012-04-24 6e15cb51ddcf24c725633c4ab1ff71959b036eb4

 src/com/gitblit/IUserService.java

@@ -40,6 +40,22 @@
   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 team memberships?

    * 
    * @return true or false

    * @since 1.0.0

    */	
   boolean supportsTeamMembershipChanges();

	
   /**

    * Does the user service support cookie authentication?

    * 

    * @return true or false

@@ -121,6 +137,14 @@
    * @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.

@@ -131,12 +155,21 @@
   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);



@@ -148,6 +181,7 @@
    *            the repository name

    * @param teamnames

    * @return true if successful

    * @since 0.8.0

    */   

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

   

@@ -207,6 +241,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);