Add 'aliasId' and 'aliasZid' Fields to ScimUser

model/src/main/java/org/cloudfoundry/identity/uaa/scim/ScimUser.java

@@ -23,9 +23,11 @@
 import java.util.Objects;
 import java.util.Set;
 
+import org.cloudfoundry.identity.uaa.EntityWithAlias;
 import org.cloudfoundry.identity.uaa.approval.Approval;
 import org.cloudfoundry.identity.uaa.impl.JsonDateSerializer;
 import org.cloudfoundry.identity.uaa.scim.impl.ScimUserJsonDeserializer;
+import org.springframework.lang.NonNull;
 import org.springframework.util.Assert;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -34,6 +36,8 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
+import lombok.Setter;
+
 /**
  * Object to hold SCIM data for Jackson to map to and from JSON
  *
@@ -45,7 +49,7 @@
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonDeserialize(using = ScimUserJsonDeserializer.class)
-public class ScimUser extends ScimCore<ScimUser> {
+public class ScimUser extends ScimCore<ScimUser> implements EntityWithAlias {
 
     @JsonInclude(JsonInclude.Include.NON_NULL)
     public static final class Group {
@@ -349,6 +353,14 @@ public int hashCode() {
 
     private String zoneId = null;
 
+    @JsonIgnore
+    @Setter
+    private String aliasZid = null;
+
+    @JsonIgnore
+    @Setter
+    private String aliasId = null;
+
     private String salt = null;
 
     private Date passwordLastModified = null;
@@ -413,7 +425,7 @@ public Set<Group> getGroups() {
         return groups;
     }
 
-    public void setGroups(Collection<Group> groups) {
+    public void setGroups(@NonNull Collection<Group> groups) {
         this.groups = new LinkedHashSet<>(groups);
     }
 
@@ -532,6 +544,7 @@ public ScimUser setExternalId(String externalId) {
         return this;
     }
 
+    @Override
     public String getZoneId() {
         return zoneId;
     }
@@ -540,6 +553,16 @@ public void setZoneId(String zoneId) {
         this.zoneId = zoneId;
     }
 
+    @Override
+    public String getAliasId() {
+        return aliasId;
+    }
+
+    @Override
+    public String getAliasZid() {
+        return aliasZid;
+    }
+
     public String getSalt() {
         return salt;
     }
@@ -718,6 +741,67 @@ List<String> wordList() {
     public void patch(ScimUser patch) {
         //Delete Attributes specified in Meta.attributes
         String[] attributes = ofNullable(patch.getMeta().getAttributes()).orElse(new String[0]);
+        removeAttributesForPatch(patch, attributes);
+
+        if (hasText(patch.getOrigin()) && !patch.getOrigin().equals(getOrigin())) {
+            throw new IllegalArgumentException("Cannot change origin in patch of user.");
+        }
+
+        //Merge simple Attributes, that are stored
+        ofNullable(patch.getUserName()).ifPresent(this::setUserName);
+
+        setActive(patch.isActive());
+        setVerified(patch.isVerified());
+
+        //Merge complex attributes
+        ScimUser.Name patchName = patch.getName();
+        if (patchName != null) {
+            patchName(patchName);
+        }
+
+        ofNullable(patch.getDisplayName()).ifPresent(
+                this::setDisplayName
+        );
+        ofNullable(patch.getNickName()).ifPresent(this::setNickName);
+        ofNullable(patch.getTimezone()).ifPresent(this::setTimezone);
+        ofNullable(patch.getTitle()).ifPresent(this::setTitle);
+        ofNullable(patch.getProfileUrl()).ifPresent(this::setProfileUrl);
+        ofNullable(patch.getLocale()).ifPresent(this::setLocale);
+        ofNullable(patch.getPreferredLanguage()).ifPresent(this::setPreferredLanguage);
+
+        //Only one email stored, use Primary or first.
+        if (patch.getEmails() != null && patch.getEmails().size()>0) {
+            ScimUser.Email primary = null;
+            for (ScimUser.Email email : patch.getEmails()) {
+                if (email.isPrimary()) {
+                   primary = email;
+                   break;
+                }
+            }
+            List<Email> currentEmails = ofNullable(getEmails()).orElse(new ArrayList());
+            if (primary != null) {
+                for (Email e : currentEmails) {
+                    e.setPrimary(false);
+                }
+            }
+            currentEmails.addAll(patch.getEmails());
+            setEmails(currentEmails);
+        }
+
+        //Only one PhoneNumber stored, use first, as primary does not exist
+        if (patch.getPhoneNumbers() != null && patch.getPhoneNumbers().size()>0) {
+            List<PhoneNumber> current = ofNullable(getPhoneNumbers()).orElse(new ArrayList<>());
+            for (int index=0; index<patch.getPhoneNumbers().size(); index++) {
+                current.add(index, patch.getPhoneNumbers().get(index));
+            }
+            setPhoneNumbers(current);
+        }
+
+        ofNullable(patch.getAliasId()).ifPresent(this::setAliasId);
+        ofNullable(patch.getAliasZid()).ifPresent(this::setAliasZid);
+    }
+
+    private void removeAttributesForPatch(final ScimUser patch, final String[] attributes) {
         for (String attribute : attributes) {
             switch (attribute.toUpperCase()) {
                 case "USERNAME":
@@ -778,67 +862,16 @@ public void patch(ScimUser patch) {
                     throw new IllegalArgumentException(String.format("Attribute %s cannot be removed using \"Meta.attributes\"", attribute));
             }
         }
-
-        if (hasText(patch.getOrigin()) && !patch.getOrigin().equals(getOrigin())) {
-            throw new IllegalArgumentException("Cannot change origin in patch of user.");
-        }
-
-        //Merge simple Attributes, that are stored
-        ofNullable(patch.getUserName()).ifPresent(this::setUserName);
-
-        setActive(patch.isActive());
-        setVerified(patch.isVerified());
-
-        //Merge complex attributes
-        ScimUser.Name patchName = patch.getName();
-        if (patchName != null) {
-            ScimUser.Name currentName = ofNullable(getName()).orElse(new Name());
-            ofNullable(patchName.getFamilyName()).ifPresent(currentName::setFamilyName);
-            ofNullable(patchName.getGivenName()).ifPresent(currentName::setGivenName);
-            ofNullable(patchName.getMiddleName()).ifPresent(currentName::setMiddleName);
-            ofNullable(patchName.getFormatted()).ifPresent(currentName::setFormatted);
-            ofNullable(patchName.getHonorificPrefix()).ifPresent(currentName::setHonorificPrefix);
-            ofNullable(patchName.getHonorificSuffix()).ifPresent(currentName::setHonorificSuffix);
-            setName(currentName);
-        }
-
-        ofNullable(patch.getDisplayName()).ifPresent(
-                this::setDisplayName
-        );
-        ofNullable(patch.getNickName()).ifPresent(this::setNickName);
-        ofNullable(patch.getTimezone()).ifPresent(this::setTimezone);
-        ofNullable(patch.getTitle()).ifPresent(this::setTitle);
-        ofNullable(patch.getProfileUrl()).ifPresent(this::setProfileUrl);
-        ofNullable(patch.getLocale()).ifPresent(this::setLocale);
-        ofNullable(patch.getPreferredLanguage()).ifPresent(this::setPreferredLanguage);
-
-        //Only one email stored, use Primary or first.
-        if (patch.getEmails() != null && patch.getEmails().size()>0) {
-            ScimUser.Email primary = null;
-            for (ScimUser.Email email : patch.getEmails()) {
-                if (email.isPrimary()) {
-                   primary = email;
-                   break;
-                }
-            }
-            List<Email> currentEmails = ofNullable(getEmails()).orElse(new ArrayList());
-            if (primary != null) {
-                for (Email e : currentEmails) {
-                    e.setPrimary(false);
-                }
-            }
-            currentEmails.addAll(patch.getEmails());
-            setEmails(currentEmails);
-        }
-
-        //Only one PhoneNumber stored, use first, as primary does not exist
-        if (patch.getPhoneNumbers() != null && patch.getPhoneNumbers().size()>0) {
-            List<PhoneNumber> current = ofNullable(getPhoneNumbers()).orElse(new ArrayList<>());
-            for (int index=0; index<patch.getPhoneNumbers().size(); index++) {
-                current.add(index, patch.getPhoneNumbers().get(index));
-            }
-            setPhoneNumbers(current);
-        }
     }
 
+    private void patchName(@NonNull final Name patchName) {
+        Name currentName = ofNullable(getName()).orElse(new Name());
+        ofNullable(patchName.getFamilyName()).ifPresent(currentName::setFamilyName);
+        ofNullable(patchName.getGivenName()).ifPresent(currentName::setGivenName);
+        ofNullable(patchName.getMiddleName()).ifPresent(currentName::setMiddleName);
+        ofNullable(patchName.getFormatted()).ifPresent(currentName::setFormatted);
+        ofNullable(patchName.getHonorificPrefix()).ifPresent(currentName::setHonorificPrefix);
+        ofNullable(patchName.getHonorificSuffix()).ifPresent(currentName::setHonorificSuffix);
+        setName(currentName);
+    }
 }

server/src/test/java/org/cloudfoundry/identity/uaa/scim/ScimUserTests.java → model/src/test/java/org/cloudfoundry/identity/uaa/scim/ScimUserTests.java

@@ -12,7 +12,6 @@
  *******************************************************************************/
 package org.cloudfoundry.identity.uaa.scim;
 
-import org.assertj.core.api.Assertions;
 import org.cloudfoundry.identity.uaa.approval.Approval;
 import org.cloudfoundry.identity.uaa.scim.ScimUser.Group;
 import org.cloudfoundry.identity.uaa.util.JsonUtils;
@@ -30,7 +29,9 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Set;
+import java.util.UUID;
 
+import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
 import static org.junit.Assert.*;
 
 /**
@@ -363,8 +364,6 @@ public void testGroupSettersGetters() {
         Group group2 = new Group("id", "display", Group.Type.DIRECT);
         assertEquals(group1, group2);
         assertEquals(group2, group1);
-        assertEquals(group1, group1);
-        assertEquals(group2, group2);
         assertNotEquals(null, group1);
         assertNotEquals(group1, new Object());
         group1.setValue(null);
@@ -451,14 +450,12 @@ public void testPhoneNumber() {
         assertEquals("type", p1.getType());
         ScimUser user = new ScimUser();
         user.setPhoneNumbers(Collections.singletonList(p1));
-        try {
-            p1.setType(null);
-            user.addPhoneNumber(p1.getValue());
-            fail();
-        }catch (IllegalArgumentException ignored) {
-
-        }
 
+        // should reject adding duplicate phone number if the existing has a type set to null
+        p1.setType(null);
+        assertThatIllegalArgumentException()
+                .isThrownBy(() -> user.addPhoneNumber(p1.getValue()))
+                .withMessageStartingWith("Already contains phoneNumber");
     }
 
     @Test
@@ -495,6 +492,33 @@ public void test_patch_previous_logon() {
         assertNull(user.getPreviousLogonTime());
     }
 
+    @Test
+    public void testPatchAliasId() {
+        final String aliasId = UUID.randomUUID().toString();
+        patch.setAliasId(aliasId);
+        user.patch(patch);
+        assertEquals(aliasId, user.getAliasId());
+    }
+
+    @Test
+    public void testPatchAliasZid() {
+        final String aliasZid = UUID.randomUUID().toString();
+        patch.setAliasZid(aliasZid);
+        user.patch(patch);
+        assertEquals(aliasZid, user.getAliasZid());
+    }
+
+    @Test
+    public void testAliasPropertiesGettersAndSetters() {
+        final String aliasId = UUID.randomUUID().toString();
+        final String aliasZid = UUID.randomUUID().toString();
+
+        final ScimUser scimUser = new ScimUser("id", "uname", "gname", "fname");
+        scimUser.setAliasId(aliasId);
+        scimUser.setAliasZid(aliasZid);
+        assertEquals(aliasId, scimUser.getAliasId());
+        assertEquals(aliasZid, scimUser.getAliasZid());
+    }
 
     @Test
     public void testPatchUserSetPrimaryEmail() {
@@ -587,7 +611,7 @@ public void testPatchUserDropNameSubAttributes() {
     @Test
     public void testPatchUserRejectChangingOrigin() {
         patch.setOrigin("some-new-origin");
-        Assertions.assertThatIllegalArgumentException().isThrownBy(() -> user.patch(patch))
+        assertThatIllegalArgumentException().isThrownBy(() -> user.patch(patch))
                         .withMessage("Cannot change origin in patch of user.");
     }
 
@@ -653,20 +677,6 @@ public void testPatchUserDropNonUsedAttributes() {
         setAndPatchAndValidate("displayname", --pos);
 
         assertEquals(0, pos);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
     }
 
     public void setAndPatchAndValidate(String attribute, int nullable) {