10018 [JM-1281] Fixed an exception using a user with a not visible email and...

10018 [JM-1281] Fixed an exception using a user with a not visible email and CS as a provider. And a problem with user search.

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/trunk@10022 b35dd754-fafc-0310-a699-88a17e54d16e

src/java/org/jivesoftware/openfire/clearspace/ClearspaceUserProvider.java

@@ -23,22 +23,36 @@ import org.xmpp.packet.JID;
 import java.util.*;
 
 /**
- * @author Daniel Henninger
+ * The ClearspaceUserProvider uses the UserService and ProfileSearchService web service inside of Clearspace
+ * to retrieve user information and to search for users from Clearspace.
+ *
+ * @author Gabriel Guardincerri
  */
 public class ClearspaceUserProvider implements UserProvider {
+
+    // The UserService webservice url prefix
     protected static final String USER_URL_PREFIX = "userService/";
+    // The ProfileSearchService webservice url prefix
     protected static final String SEARCH_URL_PREFIX = "profileSearchService/";
 
     private ClearspaceManager manager;
+
+    // Used to know it CS is a read only user provider
     private Boolean readOnly;
 
     public ClearspaceUserProvider() {
         // Gets the manager
         manager = ClearspaceManager.getInstance();
-
-        loadReadOnly();
     }
 
+    /**
+     * Loads the user using the userService/users GET service. Only loads local users.
+     * Throws a UserNotFoundException exception if the user could not be found.
+     *
+     * @param username the username of the user to load
+     * @return a user instance with the user information
+     * @throws UserNotFoundException if the user could not be found
+     */
     public User loadUser(String username) throws UserNotFoundException {
         // Checks if the user is local
         if (username.contains("@")) {
@@ -52,6 +66,19 @@ public class ClearspaceUserProvider implements UserProvider {
         return translate(getUserByUsername(username));
     }
 
+    /**
+     * Creates user using the userService/users POST service. If Clearspace is a read only
+     * provider throws an UnsupportedOperationException. If there is already a user with
+     * the username throws a UserAlreadyExistsException.
+     *
+     * @param username the username of the user
+     * @param password the password of the user
+     * @param name     the name of the user (optional)
+     * @param email    the email of the user
+     * @return an instance of the created user
+     * @throws UserAlreadyExistsException    If there is already a user with the username
+     * @throws UnsupportedOperationException If Clearspace is a read only provider
+     */
     public User createUser(String username, String password, String name, String email) throws UserAlreadyExistsException {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -100,6 +127,11 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Creates user using the userService/users DELETE service. If the user is not found returns.
+     *
+     * @param username the username of the user to delete
+     */
     public void deleteUser(String username) {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -119,6 +151,11 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Gets the user count using the userService/users/count GET service.
+     *
+     * @return the user count
+     */
     public int getUserCount() {
         try {
             String path = USER_URL_PREFIX + "users/count";
@@ -131,11 +168,21 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Gets all users using the userService/userNames GET service.
+     *
+     * @return a list of all users
+     */
     public Collection<User> getUsers() {
         Collection<String> usernames = getUsernames();
         return new UserCollection(usernames.toArray(new String[usernames.size()]));
     }
 
+    /**
+     * Gets all  usernames using the userService/userNames GET service.
+     *
+     * @return a list of all the usernames
+     */
     public Collection<String> getUsernames() {
         try {
             String path = USER_URL_PREFIX + "userNames";
@@ -148,6 +195,13 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Gets a bounded list of users using the userService/userNames GET service.
+     *
+     * @param startIndex the start index
+     * @param numResults the number of result
+     * @return a bounded list of users
+     */
     public Collection<User> getUsers(int startIndex, int numResults) {
         String[] usernamesAll = getUsernames().toArray(new String[0]);
         Collection<String> usernames = new ArrayList<String>();
@@ -160,6 +214,13 @@ public class ClearspaceUserProvider implements UserProvider {
         return new UserCollection(usernames.toArray(new String[usernames.size()]));
     }
 
+    /**
+     * Updates the name of the user using the userService/update service.
+     *
+     * @param username the username of the user
+     * @param name     the new name of the user
+     * @throws UserNotFoundException if there is no user with that username
+     */
     public void setName(String username, String name) throws UserNotFoundException {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -177,6 +238,13 @@ public class ClearspaceUserProvider implements UserProvider {
         updateUser(userUpdateParams);
     }
 
+    /**
+     * Updates the email of the user using the userService/update service.
+     *
+     * @param username the username of the user
+     * @param email    the new email of the user
+     * @throws UserNotFoundException if the user could not be found
+     */
     public void setEmail(String username, String email) throws UserNotFoundException {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -194,6 +262,14 @@ public class ClearspaceUserProvider implements UserProvider {
         updateUser(userUpdateParams);
     }
 
+
+    /**
+     * Updates the creationDate of the user using the userService/update service.
+     *
+     * @param username     the username of the user
+     * @param creationDate the new email of the user
+     * @throws UserNotFoundException if the user could not be found
+     */
     public void setCreationDate(String username, Date creationDate) throws UserNotFoundException {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -212,6 +288,13 @@ public class ClearspaceUserProvider implements UserProvider {
         updateUser(userUpdateParams);
     }
 
+    /**
+     * Updates the modificationDate of the user using the userService/update service.
+     *
+     * @param username         the username of the user
+     * @param modificationDate the new modificationDate of the user
+     * @throws UserNotFoundException if the user could not be found
+     */
     public void setModificationDate(String username, Date modificationDate) throws UserNotFoundException {
         if (isReadOnly()) {
             // Reject the operation since the provider is read-only
@@ -230,6 +313,13 @@ public class ClearspaceUserProvider implements UserProvider {
         updateUser(userUpdateParams);
     }
 
+    /**
+     * Creates the parameters to send in a update user request based on the information of <code>username</code>
+     *
+     * @param username the username of the user
+     * @return the parameters to send in a update user request
+     * @throws UserNotFoundException if the user could not be found
+     */
     protected Element getUserUpdateParams(String username) throws UserNotFoundException {
         // Creates the user update params element
         Element userUpdateParams = DocumentHelper.createDocument().addElement("updateUser");
@@ -246,6 +336,12 @@ public class ClearspaceUserProvider implements UserProvider {
         return userUpdateParams;
     }
 
+    /**
+     * Updates the user using the userService/users PUT service.
+     *
+     * @param userUpdateParams the request parameters
+     * @throws UserNotFoundException if the user could not be found
+     */
     protected void updateUser(Element userUpdateParams) throws UserNotFoundException {
         try {
             String path = USER_URL_PREFIX + "users";
@@ -259,32 +355,44 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Clearsapce can search using three fields: username, name and email.
+     *
+     * @return a list of username, name and email
+     * @throws UnsupportedOperationException
+     */
     public Set<String> getSearchFields() throws UnsupportedOperationException {
         return new LinkedHashSet<String>(Arrays.asList("Username", "Name", "Email"));
     }
 
+    /**
+     * Search for the user using the userService/search POST method.
+     *
+     * @param fields the fields to search on.
+     * @param query  the query string.
+     * @return a Collection of users that match the search.
+     * @throws UnsupportedOperationException if the provider does not
+     *                                       support the operation (this is an optional operation).
+     */
     public Collection<User> findUsers(Set<String> fields, String query) throws UnsupportedOperationException {
         // Creates the XML with the data
-        Document groupDoc = DocumentHelper.createDocument();
-        Element rootE = groupDoc.addElement("searchProfile");
-        Element queryE = rootE.addElement("WSProfileSearchQuery");
-        Element keywords = queryE.addElement("keywords");
-        keywords.addText(query);
-        Element searchUsername = queryE.addElement("searchUsername");
-        searchUsername.addText("true");
-        Element searchName = queryE.addElement("searchName");
-        searchName.addText("true");
-        Element searchEmail = queryE.addElement("searchEmail");
-        searchEmail.addText("true");
-        Element searchProfile = queryE.addElement("searchProfile");
-        searchProfile.addText("false");
+        Element paramsE = DocumentHelper.createDocument().addElement("search");
+
+        Element queryE = paramsE.addElement("query");
+
+        queryE.addElement("keywords").addText(query);
+
+        queryE.addElement("searchUsername").addText("true");
+        queryE.addElement("searchName").addText("true");
+        queryE.addElement("searchEmail").addText("true");
+        queryE.addElement("searchProfile").addText("false");
 
         try {
             List<String> usernames = new ArrayList<String>();
 
-            String path = SEARCH_URL_PREFIX + "searchProfile";
             //TODO create a service on CS to get only the username field
-            Element element = manager.executeRequest(GET, path);
+            String path = SEARCH_URL_PREFIX + "searchProfile";
+            Element element = manager.executeRequest(POST, path, paramsE.asXML());
 
             List<Node> userNodes = (List<Node>) element.selectNodes("return");
             for (Node userNode : userNodes) {
@@ -299,28 +407,40 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Search for the user using the userService/searchBounded POST method.
+     *
+     * @param fields     the fields to search on.
+     * @param query      the query string.
+     * @param startIndex the starting index in the search result to return.
+     * @param numResults the number of users to return in the search result.
+     * @return a Collection of users that match the search.
+     * @throws UnsupportedOperationException if the provider does not
+     *                                       support the operation (this is an optional operation).
+     */
     public Collection<User> findUsers(Set<String> fields, String query, int startIndex, int numResults) throws UnsupportedOperationException {
         // Creates the XML with the data
-        Document groupDoc = DocumentHelper.createDocument();
-        Element rootE = groupDoc.addElement("searchBounded");
-        Element queryE = rootE.addElement("WSProfileSearchQuery");
-        Element keywords = queryE.addElement("keywords");
-        keywords.addText(query);
-        Element searchUsername = queryE.addElement("searchUsername");
-        searchUsername.addText("true");
-        Element searchName = queryE.addElement("searchName");
-        searchName.addText("true");
-        Element searchEmail = queryE.addElement("searchEmail");
-        searchEmail.addText("true");
-        Element searchProfile = queryE.addElement("searchProfile");
-        searchProfile.addText("false");
+        Element paramsE = DocumentHelper.createDocument().addElement("searchBounded");
+
+        Element queryE = paramsE.addElement("query");
+
+        queryE.addElement("keywords").addText(query);
+
+        queryE.addElement("searchUsername").addText("true");
+        queryE.addElement("searchName").addText("true");
+        queryE.addElement("searchEmail").addText("true");
+        queryE.addElement("searchProfile").addText("false");
+
+        paramsE.addElement("startIndex").addText(String.valueOf(startIndex));
+        paramsE.addElement("numResults").addText(String.valueOf(numResults));
 
         try {
             List<String> usernames = new ArrayList<String>();
 
-            String path = SEARCH_URL_PREFIX + "searchProfile/" + startIndex + "/" + numResults;
-            Element element = manager.executeRequest(GET, path);
             //TODO create a service on CS to get only the username field
+            String path = SEARCH_URL_PREFIX + "searchProfile";
+            Element element = manager.executeRequest(POST, path, paramsE.asXML());
+
             List<Node> userNodes = (List<Node>) element.selectNodes("return");
             for (Node userNode : userNodes) {
                 String username = userNode.selectSingleNode("username").getText();
@@ -334,22 +454,44 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Returns true if Clearspace is a read only user provider.
+     *
+     * @return true if Clearspace is a read only user provider
+     */
     public boolean isReadOnly() {
         if (readOnly == null) {
-            loadReadOnly();
+            synchronized (this) {
+                if (readOnly == null) {
+                    loadReadOnly();
+                }
+            }
         }
         // If it is null returns the most restrictive answer.
         return (readOnly == null ? false : readOnly);
     }
 
+    /**
+     * In Clearspace name is optional.
+     *
+     * @return false
+     */
     public boolean isNameRequired() {
         return false;
     }
 
+    /**
+     * In Clearspace email is required
+     *
+     * @return true
+     */
     public boolean isEmailRequired() {
         return true;
     }
 
+    /**
+     * Tries to load the read only attribute using the userService/isReadOnly service.
+     */
     private void loadReadOnly() {
         try {
             // See if the is read only
@@ -361,6 +503,12 @@ public class ClearspaceUserProvider implements UserProvider {
         }
     }
 
+    /**
+     * Translates a Clearspace xml user response into a Openfire User
+     *
+     * @param responseNode the Clearspace response
+     * @return a User instance with its information
+     */
     private User translate(Node responseNode) {
         String username = null;
         String name = null;
@@ -376,20 +524,20 @@ public class ClearspaceUserProvider implements UserProvider {
 
         // Gets the name if it is visible
         boolean nameVisible = Boolean.valueOf(userNode.selectSingleNode("nameVisible").getText());
-        if (nameVisible) {
-            tmpNode = userNode.selectSingleNode("name");
-            if (tmpNode != null) {
-                name = tmpNode.getText();
-            }
+
+        // Gets the name
+        tmpNode = userNode.selectSingleNode("name");
+        if (tmpNode != null) {
+            name = tmpNode.getText();
         }
 
         // Gets the email if it is visible
         boolean emailVisible = Boolean.valueOf(userNode.selectSingleNode("emailVisible").getText());
-        if (emailVisible) {
-            tmpNode = userNode.selectSingleNode("email");
-            if (tmpNode != null) {
-                email = tmpNode.getText();
-            }
+
+        // Gets the email
+        tmpNode = userNode.selectSingleNode("email");
+        if (tmpNode != null) {
+            email = tmpNode.getText();
         }
 
         // Gets the creation date
@@ -405,9 +553,19 @@ public class ClearspaceUserProvider implements UserProvider {
         }
 
         // Creates the user
-        return new User(username, name, email, creationDate, modificationDate);
+        User user = new User(username, name, email, creationDate, modificationDate);
+        user.setNameVisible(nameVisible);
+        user.setEmailVisible(emailVisible);
+        return user;
     }
 
+    /**
+     * Gets a user using the userService/users GET service.
+     *
+     * @param username the username of the user
+     * @return the user xml response
+     * @throws UserNotFoundException if the user could not be found
+     */
     private Element getUserByUsername(String username) throws UserNotFoundException {
         try {
 

src/java/org/jivesoftware/openfire/clearspace/ClearspaceVCardTranslator.java

@@ -139,10 +139,10 @@ class ClearspaceVCardTranslator {
     /**
      * Init the fields of clearspace based on they name.
      *
-     * @param fieldsId
+     * @param fields the fields information
      */
-    protected void initClearspaceFieldsId(Element fieldsId) {
-        List<Element> fieldsList = fieldsId.elements("return");
+    protected void initClearspaceFieldsId(Element fields) {
+        List<Element> fieldsList = fields.elements("return");
         for (Element field : fieldsList) {
             String fieldName = field.elementText("name");
             long fieldID = Long.valueOf(field.elementText("ID"));
@@ -155,6 +155,16 @@ class ClearspaceVCardTranslator {
 
     }
 
+    /**
+     * Translates a VCard of Openfire into profiles, user information and a avatar of Clearspace.
+     * Returns what can of action has been made over the the profilesElement, userElement and avatarElement/
+     *
+     * @param vCardElement    the VCard information
+     * @param profilesElement the profile to add/modify/delete the information
+     * @param userElement     the user to add/modify/delete the information
+     * @param avatarElement   the avatar to add/modify/delete the information
+     * @return a list of actions performed over the profilesElement, userElement and avatarElement
+     */
     protected Action[] translateVCard(Element vCardElement, Element profilesElement, Element userElement, Element avatarElement) {
         Action[] actions = new Action[3];
 
@@ -171,6 +181,13 @@ class ClearspaceVCardTranslator {
         return actions;
     }
 
+    /**
+     * Updates the avatar values based on the vCard values
+     *
+     * @param avatarElement the avatar element to update
+     * @param vCardValues   the vCard values with the information
+     * @return the action performed
+     */
     private Action updateAvatarValues(Element avatarElement, Map<VCardField, String> vCardValues) {
         Action action = Action.NO_ACTION;
 
@@ -201,6 +218,13 @@ class ClearspaceVCardTranslator {
         return action;
     }
 
+    /**
+     * Updates the user values based on the vCard values
+     *
+     * @param userElement the user element to update
+     * @param vCardValues the vCard values
+     * @return the action performed
+     */
     private Action updateUserValues(Element userElement, Map<VCardField, String> vCardValues) {
         Action action = Action.NO_ACTION;
 
@@ -228,9 +252,9 @@ class ClearspaceVCardTranslator {
     /**
      * Updates the values of the profiles with the values of the vCard
      *
-     * @param profiles
-     * @param vCardValues
-     * @return
+     * @param profiles    the profiles element to update
+     * @param vCardValues the vCard values
+     * @return the action performed
      */
     private Action updateProfilesValues(Element profiles, Map<VCardField, String> vCardValues) {
         Action action = Action.NO_ACTION;
@@ -259,32 +283,32 @@ class ClearspaceVCardTranslator {
             String oldValue;
             switch (field) {
                 case TITLE:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.TITLE)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.TITLE)) {
                         action = Action.MODIFY;
                     }
                     break;
                 case DEPARTMENT:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.ORG_ORGUNIT)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.ORG_ORGUNIT)) {
                         action = Action.MODIFY;
                     }
                     break;
                 case ADDRESS:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.ADR_WORK)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.ADR_WORK)) {
                         action = Action.MODIFY;
                     }
                     break;
                 case HOME_ADDRESS:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.ADR_HOME)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.ADR_HOME)) {
                         action = Action.MODIFY;
                     }
                     break;
                 case TIME_ZONE:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.TZ)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.TZ)) {
                         action = Action.MODIFY;
                     }
                     break;
                 case URL:
-                    if (modifyProfileValue(vCardValues, profiles, value, VCardField.URL)) {
+                    if (modifyProfileValue(vCardValues, value, VCardField.URL)) {
                         action = Action.MODIFY;
                     }
                     break;
@@ -454,6 +478,14 @@ class ClearspaceVCardTranslator {
         return action;
     }
 
+    /**
+     * Adds a profiles element to the profiles if it is not empty
+     *
+     * @param profiles the profiles to add a profile to
+     * @param field    the field type to add
+     * @param newValue the value to add
+     * @return true if the field was added
+     */
     private boolean addProfile(Element profiles, ClearspaceField field, String newValue) {
         // Don't add empty vales
         if (newValue == null || "".equals(newValue.trim())) {
@@ -470,7 +502,15 @@ class ClearspaceVCardTranslator {
         return true;
     }
 
-    private boolean modifyProfileValue(Map<VCardField, String> vCardValues, Element profiles, Element value, VCardField vCardField) {
+    /**
+     * Modifies the value of a profile if it is different from the original one.
+     *
+     * @param vCardValues the vCard values with the new values
+     * @param value       the current value of the profile
+     * @param vCardField  the vCard field
+     * @return true if the field was modified
+     */
+    private boolean modifyProfileValue(Map<VCardField, String> vCardValues, Element value, VCardField vCardField) {
         boolean modified = false;
         String newValue = vCardValues.get(vCardField);
 
@@ -486,6 +526,13 @@ class ClearspaceVCardTranslator {
         return modified;
     }
 
+    /**
+     * Adds the field type to the field value. Returns null if the value is empty.
+     *
+     * @param value the value
+     * @param type  the type
+     * @return the field value with the type
+     */
     private String addFieldType(String value, String type) {
         if (value == null || "".equals(value.trim())) {
             return null;
@@ -493,6 +540,13 @@ class ClearspaceVCardTranslator {
         return value + "|" + type;
     }
 
+    /**
+     * Returns the field type of a field. Return null if the field doesn't
+     * contains a type
+     *
+     * @param field the field with the type
+     * @return the field type
+     */
     private String getFieldType(String field) {
         int i = field.indexOf("|");
         if (i == -1) {
@@ -502,6 +556,13 @@ class ClearspaceVCardTranslator {
         }
     }
 
+    /**
+     * Returns the field value of a field. Return the field if the field doesn't
+     * contains a type.
+     *
+     * @param field the field
+     * @return the field value
+     */
     private String getFieldValue(String field) {
         int i = field.indexOf("|");
         if (i == -1) {
@@ -513,10 +574,10 @@ class ClearspaceVCardTranslator {
 
     /**
      * Collects the vCard values and store them into a map.
-     * They are stored with this constants:
+     * They are stored with the VCardField enum.
      *
-     * @param vCardElement
-     * @return
+     * @param vCardElement the vCard with the information
+     * @return a map of the value of the vCard.
      */
     private Map<VCardField, String> collectVCardValues(Element vCardElement) {
 
@@ -602,10 +663,10 @@ class ClearspaceVCardTranslator {
     /**
      * Translates the information from Clearspace into a VCard.
      *
-     * @param profile
-     * @param user
-     * @param avatar
-     * @return
+     * @param profile the profile
+     * @param user    the user
+     * @param avatar  the avatar
+     * @return the vCard with the information
      */
     protected Element translateClearspaceInfo(Element profile, User user, Element avatar) {
 
@@ -619,7 +680,12 @@ class ClearspaceVCardTranslator {
         return vCard;
     }
 
-
+    /**
+     * Translates the profile information to the vCard
+     *
+     * @param profiles the profile information
+     * @param vCard    the vCard to add the information to
+     */
     private void translateProfileInformation(Element profiles, Element vCard) {
         // Translate the profile XML
 
@@ -747,15 +813,21 @@ class ClearspaceVCardTranslator {
         }
     }
 
+    /**
+     * Translates the user information to the vCard
+     *
+     * @param user  the user information
+     * @param vCard the vCard to add the information to
+     */
     private void translateUserInformation(User user, Element vCard) {
-        // The name could be null (if in Clearspace the name is not visible in Openfire it is null)
-        if (user.getName() != null && !"".equals(user.getName().trim())) {
+        // Only set the name to the VCard if it is visible
+        if (user.isNameVisible()) {
             vCard.addElement("FN").setText(user.getName());
             vCard.addElement("N").addElement("FAMILY").setText(user.getName());
         }
 
-        // Email is mandatory, but may be invisible
-        if (user.getEmail() != null && !"".equals(user.getName().trim())) {
+        // Only set the eamail to the VCard if it is visible
+        if (user.isEmailVisible()) {
             Element email = vCard.addElement("EMAIL");
             email.addElement("PREF");
             email.addElement("USERID").setText(user.getEmail());
@@ -765,6 +837,12 @@ class ClearspaceVCardTranslator {
         vCard.addElement("JABBERID").setText(jid);
     }
 
+    /**
+     * Translates the avatar information to the vCard.
+     *
+     * @param avatarResponse the avatar information
+     * @param vCard          the vCard to add the information to
+     */
     private void translateAvatarInformation(Element avatarResponse, Element vCard) {
         Element avatar = avatarResponse.element("return");
         if (avatar != null) {
@@ -781,6 +859,12 @@ class ClearspaceVCardTranslator {
         }
     }
 
+    /**
+     * Translates the address string of Clearspace to the vCard format.
+     *
+     * @param address  the address string of Clearspae
+     * @param addressE the address element to add the address to
+     */
     private void translateAddress(String address, Element addressE) {
         StringTokenizer strTokenize = new StringTokenizer(address, ",");
         while (strTokenize.hasMoreTokens()) {
@@ -819,6 +903,12 @@ class ClearspaceVCardTranslator {
     }
 
 
+    /**
+     * Translates the address form the vCard format to the Clearspace string.
+     *
+     * @param addressElement the address in the vCard format
+     * @return the address int the Clearspace format
+     */
     private String translateAddress(Element addressElement) {
 
         StringBuilder sb = new StringBuilder();
@@ -850,8 +940,16 @@ class ClearspaceVCardTranslator {
         return sb.toString();
     }
 
-    private void translateAddressField(Element addressElement, String elementName, String fieldName, StringBuilder sb) {
-        String field = addressElement.elementTextTrim(elementName);
+    /**
+     * Translates the address field from the vCard format to the Clearspace format.
+     *
+     * @param addressElement the vCard address
+     * @param vCardFieldName the vCard field name
+     * @param fieldName      the Clearspace field name
+     * @param sb             the string builder to append the field string to
+     */
+    private void translateAddressField(Element addressElement, String vCardFieldName, String fieldName, StringBuilder sb) {
+        String field = addressElement.elementTextTrim(vCardFieldName);
         if (field != null && !"".equals(field)) {
             sb.append(fieldName).append(":").append(field).append(",");
         }

src/java/org/jivesoftware/openfire/user/User.java

@@ -57,6 +57,11 @@ public class User implements Cacheable, Externalizable, Result {
     private static final String INSERT_PROPERTY =
         "INSERT INTO jiveUserProp (username, name, propValue) VALUES (?, ?, ?)";
 
+    // The name of the name visible property
+    private static final String NAME_VISIBLE_PROPERTY = "name.visible";
+    // The name of the email visible property
+    private static final String EMAIL_VISIBLE_PROPERTY = "email.visible";
+
     private String username;
     private String name;
     private String email;
@@ -205,6 +210,24 @@ public class User implements Cacheable, Externalizable, Result {
         }
     }
 
+    /**
+     * Returns true if name is visible to everyone or not.
+     *
+     * @return true if name is visible to everyone, false if not.
+     */
+    public boolean isNameVisible() {
+        return !getProperties().containsKey(NAME_VISIBLE_PROPERTY) || Boolean.valueOf(getProperties().get(NAME_VISIBLE_PROPERTY));
+    }
+
+    /**
+     * Sets if name is visible to everyone or not.
+     *
+     * @param visible true if name is visible, false if not.
+     */
+    public void setNameVisible(boolean visible) {
+        getProperties().put(NAME_VISIBLE_PROPERTY, String.valueOf(visible));
+    }
+
     /**
      * Returns the email address of the user or <tt>null</tt> if none is defined.
      *
@@ -239,6 +262,24 @@ public class User implements Cacheable, Externalizable, Result {
         }
     }
 
+    /**
+     * Returns true if email is visible to everyone or not.
+     *
+     * @return true if email is visible to everyone, false if not.
+     */
+    public boolean isEmailVisible() {
+        return !getProperties().containsKey(EMAIL_VISIBLE_PROPERTY) || Boolean.valueOf(getProperties().get(EMAIL_VISIBLE_PROPERTY));
+    }
+
+    /**
+     * Sets if the email is visible to everyone or not.
+     *
+     * @param visible true if the email is visible, false if not.
+     */
+    public void setEmailVisible(boolean visible) {
+        getProperties().put(EMAIL_VISIBLE_PROPERTY, String.valueOf(visible));
+    }
+
     public Date getCreationDate() {
         return creationDate;
     }

src/java/org/jivesoftware/openfire/user/UserNameManager.java

@@ -22,11 +22,11 @@ import java.util.concurrent.ConcurrentHashMap;
  * entities (i.e. users) the {@link User} name is used. For remote entities the following logic
  * is used:
  * <ol>
- *  <li>Check if a {@link UserNameProvider} is registered for the entity's domain. If a provider
- *      was found then use it to get the entity's name</li>
- *  <li>If no provider was found then retrieve the vCard of the entity and return the name as
- *      defined in the vCard. <i>This is not implemented yet.</i></li>
- *  <li>If no vCard was found then return the string representation of the entity's JID.</li>
+ * <li>Check if a {@link UserNameProvider} is registered for the entity's domain. If a provider
+ * was found then use it to get the entity's name</li>
+ * <li>If no provider was found then retrieve the vCard of the entity and return the name as
+ * defined in the vCard. <i>This is not implemented yet.</i></li>
+ * <li>If no vCard was found then return the string representation of the entity's JID.</li>
  * </ol>
  *
  * @author Gaston Dombiak
@@ -72,7 +72,7 @@ public class UserNameManager {
      * @param entity the JID of the entity to get its name.
      * @return the name of the XMPP entity.
      * @throws UserNotFoundException if the jid belongs to the local server but no user was
-     *         found for that jid.
+     *                               found for that jid.
      */
     public static String getUserName(JID entity) throws UserNotFoundException {
         return getUserName(entity, entity.toString());
@@ -85,19 +85,18 @@ public class UserNameManager {
      * the vCard of the entity might be requested and if none was found then a string
      * representation of the entity's JID will be returned.
      *
-     * @param entity the JID of the entity to get its name.
+     * @param entity      the JID of the entity to get its name.
      * @param defaultName default name to return when no name was found.
      * @return the name of the XMPP entity.
      * @throws UserNotFoundException if the jid belongs to the local server but no user was
-     *         found for that jid.
+     *                               found for that jid.
      */
     public static String getUserName(JID entity, String defaultName) throws UserNotFoundException {
         if (server.isLocal(entity)) {
             // Contact is a local entity so search for his user name
             User localUser = UserManager.getInstance().getUser(entity.getNode());
-            return "".equals(localUser.getName()) ? entity.getNode() : localUser.getName();
-        }
-        else {
+            return !localUser.isNameVisible() || "".equals(localUser.getName()) ? entity.getNode() : localUser.getName();
+        } else {
             UserNameProvider provider = providersByDomain.get(entity.getDomain());
             if (provider != null) {
                 return provider.getUserName(entity);

src/plugins/search/src/java/org/jivesoftware/openfire/plugin/SearchPlugin.java

@@ -713,11 +713,11 @@ public class SearchPlugin implements Component, Plugin, PropertyEventListener {
             items.add(fieldUsername);
 
             XFormFieldImpl fieldName = new XFormFieldImpl(LocaleUtils.getLocalizedString("advance.user.search.name", "search"));
-            fieldName.addValue(removeNull(user.getName()));
+            fieldName.addValue((user.isNameVisible() ? removeNull(user.getName()) : ""));
             items.add(fieldName);
 
             XFormFieldImpl fieldEmail = new XFormFieldImpl(LocaleUtils.getLocalizedString("advance.user.search.email", "search"));
-            fieldEmail.addValue(removeNull(user.getEmail()));
+            fieldEmail.addValue((user.isEmailVisible() ? removeNull(user.getEmail()) : ""));
             items.add(fieldEmail);
 
             searchResults.addItemFields(items);
@@ -759,13 +759,13 @@ public class SearchPlugin implements Component, Plugin, PropertyEventListener {
                 if ("Name".equals(field)) {
                     Element element = item.addElement(reverseFieldLookup
                             .get(field));
-                    element.addText(removeNull(user.getName()));
+                    element.addText(user.isNameVisible() ? removeNull(user.getName()) : "");
                 }
 
                 if ("Email".equals(field)) {
                     Element element = item.addElement(reverseFieldLookup
                             .get(field));
-                    element.addText(removeNull(user.getEmail()));
+                    element.addText(user.isEmailVisible() ? removeNull(user.getEmail()) : "");
                 }
             }
         }
@@ -1006,12 +1006,13 @@ public class SearchPlugin implements Component, Plugin, PropertyEventListener {
                     }
                 }
                 else if (field.equals("Name")) {
-                    if (query.equalsIgnoreCase(user.getName())) {
-                        foundUsers.add(user);
+                    if (user.isNameVisible()) {
+                        if (query.equalsIgnoreCase(user.getName())) {
+                            foundUsers.add(user);
+                        }
                     }
-                }
-                else if (field.equals("Email")) {
-                    if (user.getEmail() != null) {
+                } else if (field.equals("Email")) {
+                    if (user.isEmailVisible() && user.getEmail() != null) {
                         if (query.equalsIgnoreCase(user.getEmail())) {
                             foundUsers.add(user);
                         }