Site service membership API (Java and JavaScript) and associated unit tests

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@9012 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/site/script/ScriptSiteService.java

@@ -28,6 +28,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 import org.alfresco.repo.jscript.BaseScopableProcessorExtension;
+import org.alfresco.repo.jscript.ScriptableHashMap;
 import org.alfresco.repo.site.SiteInfo;
 import org.alfresco.repo.site.SiteService;
 
@@ -78,9 +79,9 @@ public class ScriptSiteService extends BaseScopableProcessorExtension
      * 
      * @param nameFilter        name filter
      * @param sitePresetFilter  site preset filter
-     * @return List<Site>       a list of the site filtered as appropriate             
+     * @return Site[]           a list of the site filtered as appropriate             
      */
-    public List<Site> listSites(String nameFilter, String sitePresetFilter)
+    public Site[] listSites(String nameFilter, String sitePresetFilter)
     {
         List<SiteInfo> siteInfos = this.siteService.listSites(nameFilter, sitePresetFilter);
         List<Site> sites = new ArrayList<Site>(siteInfos.size());
@@ -88,7 +89,7 @@ public class ScriptSiteService extends BaseScopableProcessorExtension
         {
             sites.add(new Site(this.siteService, siteInfo));
         }
-        return sites;
+        return (Site[])sites.toArray(new Site[sites.size()]);
     }      
     
     /**

source/java/org/alfresco/repo/site/script/Site.java

@@ -25,15 +25,22 @@
 package org.alfresco.repo.site.script;
 
 import java.io.Serializable;
+import java.util.Map;
 
+import org.alfresco.repo.jscript.ScriptableHashMap;
 import org.alfresco.repo.site.SiteInfo;
 import org.alfresco.repo.site.SiteService;
+import org.jgroups.util.GetNetworkInterfaces1_4;
+import org.mozilla.javascript.ScriptableObject;
 
 /**
+ * Site JavaScript object
+ * 
  * @author Roy Wetherall
  */
 public class Site implements Serializable
 {
+    /** Serializable serial verion UID */
     private static final long serialVersionUID = 8013569574120957923L;
  
     /** Site information */
@@ -164,4 +171,53 @@ public class Site implements Serializable
         // Delete the site
         this.siteService.deleteSite(this.siteInfo.getShortName());
     }
+    
+    /**
+     * Gets a map of members of the site with their role within the site.  This list can
+     * be filtered by name and/or role.
+     * <p>
+     * If no name or role filter is specified all members of the site are listed. 
+     * 
+     * @param nameFilter                            user name filter
+     * @param roleFilter                            user role filter
+     * @return ScriptableHashMap<String, String>    list of members of site with their roles
+     */
+    public ScriptableHashMap<String, String> listMembers(String nameFilter, String roleFilter)
+    {
+        Map<String, String> sites =  this.siteService.listMembers(getShortName(), nameFilter, roleFilter);
+        
+        ScriptableHashMap<String, String> result = new ScriptableHashMap<String, String>();
+        result.putAll(sites);
+        
+        return result;
+    }
+    
+    /**
+     * Sets the membership details for a user.
+     * <p>
+     * If the user is not already a member of the site then they are added with the role
+     * given.  If the user is already a member of the site then their role is updated to the new role.
+     * <p>
+     * Only a site manager can modify memberships and there must be at least one site manager at
+     * all times.
+     * 
+     * @param userName  user name
+     * @param role      site role
+     */
+    public void setMembership(String userName, String role)
+    {
+        this.siteService.setMembership(getShortName(), userName, role);
+    }
+    
+    /**
+     * Removes a users membership of the site.
+     * <p>
+     * Only a site manager can remove a user's membership and the last site manager can not be removed.
+     * 
+     * @param userName  user name
+     */
+    public void removeMembership(String userName)
+    {
+        this.siteService.removeMembership(getShortName(), userName);
+    }
 }

source/java/org/alfresco/repo/site/script/test_siteService.js

@@ -1,11 +1,11 @@
 function checkSite(site, sitePreset, shortName, title, description, isPublic)
 {
-	test.assertNotNull(site, "Site should not be null");
-	test.assertEquals(sitePreset, site.sitePreset, "Site preset incorrect for site " + shortName);
-	test.assertEquals(shortName, site.shortName, "Site shortname incorrect");
-	test.assertEquals(title, site.title, "Site title incorrect for site " + shortName);
-	test.assertEquals(description, site.description, "Site description incorrect for site " + shortName);
-	test.assertEquals(isPublic, site.isPublic, "Site ispublic incorrect for site " + shortName);
+	test.assertNotNull(site);
+	test.assertEquals(sitePreset, site.sitePreset);
+	test.assertEquals(shortName, site.shortName);
+	test.assertEquals(title, site.title);
+	test.assertEquals(description, site.description);
+	test.assertEquals(isPublic, site.isPublic);
 }
 
 function testCRUD()
@@ -39,9 +39,46 @@ function testCRUD()
 
 function testListSites()
 {
-	// TODO
+	// Create a couple of sites
+	siteService.createSite("sitePreset", "siteShortName", "siteTitle", "siteDescription", true);
+	siteService.createSite("sitePreset", "siteShortName2", "siteTitle", "siteDescription", true);
+	
+	// List all the site
+	var sites = siteService.listSites(null, null);
+	
+	// Check the list
+	test.assertNotNull(sites);
+	test.assertEquals(2, sites.length);
+	
+	// TODO .. check the filters
+}
+
+function testMembership()
+{
+	var site = siteService.getSite("siteShortName");
+	test.assertNotNull(site);
+	
+	var members = site.listMembers(null, null);
+	test.assertNotNull(members);
+	test.assertEquals(1, members.length);
+	test.assertEquals("SiteManager", members["UserOne"]);
+	
+	site.setMembership("UserTwo", "SiteCollaborator");
+	members = site.listMembers(null, null);
+	test.assertNotNull(members);
+	test.assertEquals(2, members.length);
+	test.assertEquals("SiteManager", members["UserOne"]);
+	test.assertEquals("SiteCollaborator", members["UserTwo"]);
+	
+	site.removeMembership("UserTwo");
+	members = site.listMembers(null, null);
+	test.assertNotNull(members);
+	test.assertEquals(1, members.length);
+	test.assertEquals("SiteManager", members["UserOne"]);
+	
 }
 
 // Execute test's
 testCRUD();
-testListSites();
+testListSites();
+testMembership();