Feature #3934 - upgrading UserProfile REST WebService to get, if requested, more data about a user & adding the technical possibility to use the UserProfile JavaScript API by a synchronous way

Author: SilverYoCha

war-core/src/main/webapp/util/javaScript/silverpeas-profile.js

@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright (C) 2000 - 2012 Silverpeas
  *
  * This program is free software: you can redistribute it and/or modify
@@ -36,16 +36,19 @@ function isAUserGroup(object) {
 }
 
 function UserProfile(user) {
-  
   var self = this;
+
+  var userProfileManagementParams = $.extend({extended: false, async:true}, user);
   var usermgt = new UserProfileManagement({
-    id: user.id
+    id: userProfileManagementParams.id,
+    extended : userProfileManagementParams.extended,
+    async : userProfileManagementParams.async
   });
-  
+
   if (user != null)
     for (var prop in user)
       this[prop] = user[prop];
-  
+
   /**
    * Loads the attributes of the profile of this user.
    * Whether a callback is passed as argument, invokes the callback with this user profile once its
@@ -67,7 +70,7 @@ function UserProfile(user) {
     });
     return self;
   }
-  
+
   /**
    * Sets this user as having access priviledges in the specified component instance
    * (the unique identifier of the component instance).
@@ -131,7 +134,7 @@ function UserProfile(user) {
     var callback = arguments[arg];
     if (usermgt.users == null) {
       toload = true;
-    } 
+    }
     if (usermgt.filter.name != name) {
       usermgt.filter.name = name;
       toload = true;
@@ -140,7 +143,7 @@ function UserProfile(user) {
       if (usermgt.filter.pagination == null || usermgt.filter.pagination.page != page ||
         usermgt.filter.pagination.count != pagesize) {
         usermgt.filter.pagination = {
-          page: page, 
+          page: page,
           count: pagesize
         };
         toload = true;
@@ -154,11 +157,11 @@ function UserProfile(user) {
       usermgt.get({
         contacts: true
       }, callback);
-    else 
+    else
       callback(usermgt.users);
     return self;
   }
-  
+
   /**
    * Gets the loaded relationships.
    * Returns null if the relationships were not loaded.
@@ -173,15 +176,15 @@ function UserProfile(user) {
  * It provides additional methods.
  */
 function UserGroup(group) {
-  
+
   var self        = this;
   var subgroupmgt = new UserGroupManagement();
   var usermgt     = new UserProfileManagement();
-  
+
   if (group != null)
     for (var prop in group)
       this[prop] = group[prop];
-  
+
   /**
    * Sets this user group as having access priviledges in the specified component instance
    * (the unique identifier of the component instance).
@@ -241,7 +244,7 @@ function UserGroup(group) {
     });
     return self;
   }
-  
+
   /**
    * Loads the children (subgroups) of this user group, and calls the specified callback operation
    * by passing it the fetched subgroups.
@@ -259,11 +262,11 @@ function UserGroup(group) {
         name: name,
         url: self.childrenUri
       },callback);
-    } else 
+    } else
       callback(subgroupmgt.groups);
     return self;
   }
-  
+
   /**
    * Loads the nth page of the users that belong to this group (and its subgroups), and calls the
    * specified callback operation by passing it the fetched users.
@@ -292,7 +295,7 @@ function UserGroup(group) {
     if (usermgt.users == null) {
       usermgt.filter.group = self.id;
       toload = true;
-    } 
+    }
     if (usermgt.filter.name != name) {
       usermgt.filter.name = name;
       toload = true;
@@ -301,7 +304,7 @@ function UserGroup(group) {
       if (usermgt.filter.pagination == null || usermgt.filter.pagination.page != page ||
         usermgt.filter.pagination.count != pagesize) {
         usermgt.filter.pagination = {
-          page: page, 
+          page: page,
           count: pagesize
         };
         toload = true;
@@ -313,19 +316,19 @@ function UserGroup(group) {
     }
     if (toload)
       usermgt.get(callback);
-    else 
+    else
       callback(usermgt.users);
     return self;
   }
-  
+
   /**
    * Gets the loaded subgroups of this user group.
    * Null is returned if the subgroups are not loaded.
    */
   this.children = function() {
     return subgroupmgt.groups;
   }
-  
+
   /**
    * Gets the loaded users in this user group.
    * Null is returned if the users are not loaded.
@@ -351,11 +354,12 @@ var rootUserGroup = new UserGroup({
  * You can give some parameters to filter the users on which this object works.
  */
 function UserProfileManagement(params) {
-  
+
   var self = this;
-  
+
   this.filter = {
     id: null, // the unique identifier of a user to get
+    extended: false, // a flag to load user full details
     contacts: false, // the contacts of the refered user. The id must be set to be taken into account
     group: null, // a user group unique identifier
     name: null, // a pattern about a user name (* is a wildcard)
@@ -364,10 +368,10 @@ function UserProfileManagement(params) {
     resource: null, // an identifier of a resource belonging to a component instance (the identifier
                     // must be set the resource type following by resource identifier in Silverpeas).
     roles: null, // a string with a comma-separated role names
-    pagination: null // pagination data in the form of 
+    pagination: null // pagination data in the form of
   // { page: <number of the page>, count: <count of users to fetch> }
   };
-  
+
   /**
    * The filtering parameters about the user profiles to get.
    */
@@ -376,7 +380,7 @@ function UserProfileManagement(params) {
       for(var prop in params)
         self.filter[prop] = params[prop];
   }
-  
+
   /**
    * Decorates the user profiles with usefull method to improve the usability.
    */
@@ -390,12 +394,12 @@ function UserProfileManagement(params) {
     }
     return decoratedUsers;
   }
-  
+
   setUpFilter(params);
-  
+
   // the users it manages
   this.users = null;
-  
+
   /**
    * Gets the user profiles matching the filters (if any) and passes them to the
    * specified callback 'loaded'.
@@ -412,6 +416,10 @@ function UserProfileManagement(params) {
       urlOfUsers += '/' + self.filter.id;
       if (self.filter.contacts)
         urlOfUsers += '/contacts';
+      if (self.filter.extended) {
+        urlOfUsers += separator + 'extended=' + self.filter.extended;
+        separator = '&';
+      }
       application = separator + 'application=';
       if (self.filter.component)
         separator = '&';
@@ -441,12 +449,13 @@ function UserProfileManagement(params) {
     }
     if (self.filter.pagination) {
       urlOfUsers += separator + 'page=' + self.filter.pagination.page + ';' + self.filter.pagination.count;
-    } 
+    }
     $.ajax({
       url: urlOfUsers,
       type: 'GET',
       dataType: 'json',
       cache: false,
+      async: params.async,
       success: function(users, status, jqXHR) {
         self.users = decorate(users);
         self.users.maxlength = jqXHR.getResponseHeader('X-Silverpeas-UserSize');
@@ -466,9 +475,9 @@ function UserProfileManagement(params) {
  * You can give some parameters to contraints the user groups on which this object should work.
  */
 function UserGroupManagement(params) {
-  
+
   var self = this;
-  
+
   this.filter = {
     id: null, // the unique identifier of a user group to get.
     url: null, // the URL at which the groups have to be get. If not set, the URL of the root groups
@@ -481,7 +490,7 @@ function UserGroupManagement(params) {
     resource: null // an identifier of a resource belonging to a component instance (the identifier
                    // must be set the resource type following by resource identifier in Silverpeas).
   };
-  
+
   /**
    * The filtering parameters about the user groups to get.
    */
@@ -490,7 +499,7 @@ function UserGroupManagement(params) {
       for(var prop in params)
         self.filter[prop] = params[prop];
   }
-  
+
   /**
    * Decorates the user groups with usefull method to improve the usability:
    * - children(loaded) with loaded a callback called with as argument the loaded groups,
@@ -507,12 +516,12 @@ function UserGroupManagement(params) {
     }
     return decoratedGroups;
   }
-  
+
   setUpFilter(params);
-  
+
   // the groups it manages.
   this.groups = null;
-  
+
   /**
    * Gets the user profiles matching the filters (if any) and passes them to the specified callback
    * 'loaded'.

web-core/src/main/java/com/silverpeas/profile/web/UserProfileEntity.java

@@ -100,7 +100,7 @@ public static UserProfileEntity[] fromUsers(final List<? extends UserDetail> use
   @XmlElement(defaultValue="false")
   private boolean anonymous = false;
 
-  private UserProfileEntity(UserDetail user) {
+  protected UserProfileEntity(UserDetail user) {
     this.user = user;
     UserPreferences prefs = getUserPreferences();
     if (prefs != null) {
@@ -112,7 +112,7 @@ private UserProfileEntity(UserDetail user) {
       this.domainName = UserDetail.getOrganizationController().getDomain(this.user.getDomainId()).
               getName();
     } catch (Exception e) {
-      // Potential errors during getting domain should not break service  
+      // Potential errors during getting domain should not break service
       SilverTrace.warn("util", "UserProfileEntity.constructor", "root.EX_IGNORED", e);
     }
     this.fullName = user.getDisplayedName();
@@ -121,7 +121,6 @@ private UserProfileEntity(UserDetail user) {
     this.webPage = getUserProfileWebPageURI();
     this.tchatPage = getTchatWebPageURI();
     this.anonymous = user.isAnonymous();
-    
   }
 
   @Override
@@ -167,7 +166,7 @@ public String geteMail() {
   public String getLanguage() {
     return language;
   }
-  
+
   @Override
   public void setAccessLevel(String sAccessLevel) {
     this.user.setAccessLevel(sAccessLevel);
@@ -203,7 +202,7 @@ public String getAvatar() {
     }
     return avatar;
   }
-  
+
   /**
    * Gets the URL of the WEB page in which is presented the profile of this user.
    * @return the URL of the user profile WEB page.
@@ -214,7 +213,7 @@ public String getWebPage() {
     }
     return webPage;
   }
-  
+
   /**
    * Gets the URL of the tchat WEB page opened to discuss with this user.
    * @return the URL of the user tchat page.
@@ -233,7 +232,7 @@ public String getTchatPage() {
   public String getFullName() {
     return fullName;
   }
-  
+
   /**
    * Is this user connected to Silverpeas?
    * @return true if the user is connected, false otherwise.
@@ -270,15 +269,15 @@ public void setLogin(String sLogin) {
   public String getStatus() {
     return user.getStatus();
   }
-  
+
   public void setStatus(String newStatus) {
-    
+
   }
 
   public String getDomainName() {
     return this.domainName;
   }
-  
+
   @Override
   public boolean isAnonymous() {
     return this.anonymous;
@@ -320,7 +319,7 @@ public int hashCode() {
   public URI getURI() {
     return this.uri;
   }
-  
+
   private String getAvatarURI() {
     String avatarURI = this.user.getAvatar();
     WebApplicationContext context = ContextLoaderListener.getCurrentWebApplicationContext();
@@ -329,7 +328,7 @@ private String getAvatarURI() {
     }
     return avatarURI;
   }
-  
+
   private String getUserProfileWebPageURI() {
     String pageUri = "/Rprofil/jsp/Main?userId=" + this.user.getId();
     WebApplicationContext context = ContextLoaderListener.getCurrentWebApplicationContext();
@@ -340,7 +339,7 @@ private String getUserProfileWebPageURI() {
     }
     return pageUri;
   }
-  
+
   private String getTchatWebPageURI() {
     String pageUri = "/RcommunicationUser/jsp/OpenDiscussion?userId=" + this.user.getId();
     WebApplicationContext context = ContextLoaderListener.getCurrentWebApplicationContext();