Changeset 4026 for branches/HeuristicLab.Services.Authentication Prototype/Service/Provider

Timestamp:

07/09/10 19:45:54 (14 years ago)

Author:

fruehrli

Message:

added comment for roleprovider (#1046)

File:

• branches/HeuristicLab.Services.Authentication Prototype/Service/Provider/HeuristicLabRoleProvider.cs (modified) (13 diffs)

branches/HeuristicLab.Services.Authentication Prototype/Service/Provider/HeuristicLabRoleProvider.cs

@@ -12 +12 @@
 
 
-
+    /// <summary>
+    /// adds each user in "usernames" to each role in "rolenames",
+    /// if both user and role exists
+    /// </summary>
+    /// <param name="[]usernames"></param>
+    /// <param name="[]roleNames"></param>
+    /// <returns></returns>
     public override void AddUsersToRoles(string[] usernames, string[] roleNames) {
       if (usernames != null && roleNames != null) {
@@ -30 +36 @@
       }
     }
-
+    
+    /// <summary>
+    /// gets or sets application name (implicit parameter application name) 
+    /// </summary>
+    /// <param [name="value"]></param>
+    /// <returns></returns>
     public override string ApplicationName {
       get {
@@ -40 +51 @@
     }
 
+    /// <summary>
+    /// Creates a new role with permission "false"
+    /// (Calls virtual method "CreateRole")
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <returns></returns>
     public override void CreateRole(string roleName) {
       CreateRole(roleName, false);
@@ -45 +62 @@
     }
 
+    /// <summary>
+    /// Creates and inserts a new role if param "roleName" != null
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <param name="isPermission"></param>
+    /// <returns></returns>
     public virtual void CreateRole(String roleName, bool isPermission) {
       if (roleName != null) {
@@ -57 +80 @@
     }
 
-    //
-    // RoleProvider.DeleteRole
-    //
+    /// <summary>
+    /// Deletes role from system and returns true if role has been deleted or false if not
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <param name="throwOnPopulatedRole"></param>
+    /// <returns>true or false</returns>
     public override bool DeleteRole(string roleName, bool throwOnPopulatedRole) {
       String[] roleArray = new String[1];
@@ -83 +109 @@
       return true;
     }
-
+    
+    /// <summary>
+    /// Returns string array with username if string "usernameToMatch" is find in "roleName",
+    /// or an empty array if not
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <param name="usernameToMatch"></param>
+    /// <returns>string-array with username</returns>
     public override string[] FindUsersInRole(string roleName, string usernameToMatch) {
       List<string> returnValue = new List<string>();
@@ -100 +133 @@
       return returnValue.ToArray();
     }
-
+    
+    /// <summary>
+    /// returns a string-array containing all HeuristicLabRole-rolenames 
+    /// </summary>
+    /// <param></param>
+    /// <returns>string-array containing role names</returns>
     public override string[] GetAllRoles() {
       List<string> roleList = new List<string>();
@@ -113 +151 @@
       return roleList.ToArray();
     }
-
+    
+    /// <summary>
+    /// returns a string-array containing the rolenames of all roles associated to user "username" 
+    /// returns an empty array if user "username" does not exist or no roles are associated to the user
+    /// </summary>
+    /// <param name="username"></param>
+    /// <returns>string-array containing rolenames</returns>
     public override string[] GetRolesForUser(string username) {
       List<string> roleList = new List<string>();
@@ -142 +186 @@
     
     }
-
+    
+    /// <summary>
+    /// returns a string-array containing the usernames associated to the role "roleName" 
+    /// returns an empty array if "roleName" does not exist or no users are associated to the role
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <returns>string-array containing usernames</returns>
     public override string[] GetUsersInRole(string roleName) {
       List<string> userList = new List<string>();
@@ -157 +207 @@
       return userList.ToArray();
     }
-
+    
+    /// <summary>
+    /// returns true if both user "username" and role "roleName" exists and user is associated to role
+    /// </summary>
+    /// <param name="userame"></param>
+    /// <param name="roleName"></param>
+    /// <returns>true or false</returns>
     public override bool IsUserInRole(string username, string roleName) {
       bool returnValue = false;
@@ -174 +230 @@
           }
         }
-
-
-
       }
       context.Dispose();
       return returnValue;
     }
+    
+    
+    
     protected bool ResolveChildRoles(List<HeuristicLabRole> roles, string roleName)
     {
@@ -195 +251 @@
       return returnValue;
     }
+    
+    /// <summary>
+    /// Removes for each user in "usernames" each role in "roleNames" if both user and role exists in db
+    /// and the role is associated to the user
+    /// </summary>
+    /// <param name="[]usernames"></param>
+    /// <param name="[]roleNames"></param>
+    /// <returns></returns>   
     public override void RemoveUsersFromRoles(string[] usernames, string[] roleNames) {
 
@@ -214 +278 @@
     }
 
+    
+    /// <summary>
+    /// Returns true if role "roleName" exists or false if not
+    /// </summary>
+    /// <param name="roleName"></param>
+    /// <returns>true or false</returns>
     public override bool RoleExists(string roleName) {