PB-7099. Add support to search by group name

Author: kalpeshonespan

sdk/src/main/java/com/silanis/esl/sdk/examples/GroupManagementExample.java

@@ -22,6 +22,9 @@
 public class GroupManagementExample extends SDKSample {
     public List<String> groupMemberEmailsAfterUpdate;
 
+    public static final String GROUP_NAME_PREFIX = "GROUP_";
+    public static final String EMAIL = "bob@aol.com";
+
     public Group createdGroup1;
     public Group retrievedGroup1;
     public Group createdGroup2;
@@ -30,6 +33,9 @@ public class GroupManagementExample extends SDKSample {
     public Group retrievedGroup3;
     public Group createdGroup3Updated;
 
+    public List<Group> retrievedGroupByName1;
+    public List<Group> retrievedByNamePrefix;
+
     public static void main( String... args ) {
         new GroupManagementExample().run();
     }
@@ -84,15 +90,18 @@ public void execute() {
         inviteAccountMember( email4 );
 
         // Let's create and manage some groups
-        Group group1 = GroupBuilder.newGroup( UUID.randomUUID().toString() )
+        String groupName = UUID.randomUUID().toString();
+        Group group1 = GroupBuilder.newGroup( GROUP_NAME_PREFIX + groupName )
                 .withId( new GroupId( UUID.randomUUID().toString() ) )
                 .withMember( GroupMemberBuilder.newGroupMember( email1 )
                         .as( GroupMemberType.MANAGER ) )
-                .withEmail( "bob@aol.com" )
+                .withEmail( EMAIL )
                 .withIndividualMemberEmailing()
                 .build();
         createdGroup1 = eslClient.getGroupService().createGroup( group1 );
         retrievedGroup1 = eslClient.getGroupService().getGroup(createdGroup1.getId());
+        // Retrieve by group name
+        retrievedGroupByName1 = eslClient.getGroupService().getMyGroups(groupName);
 
         // Inviting members with the two different calls
         // addMember returns the group member while inviteMember returns the group itself
@@ -103,28 +112,29 @@ public void execute() {
                 .as(GroupMemberType.MANAGER)
                 .build());
 
-        Group group2 = GroupBuilder.newGroup( UUID.randomUUID().toString() )
+        groupName = UUID.randomUUID().toString();
+        Group group2 = GroupBuilder.newGroup( GROUP_NAME_PREFIX + groupName )
                 .withMember( GroupMemberBuilder.newGroupMember( email2 )
                         .as( GroupMemberType.MANAGER ) )
-                .withEmail( "bob@aol.com" )
+                .withEmail( EMAIL )
                 .withIndividualMemberEmailing()
                 .build();
 
         createdGroup2 = eslClient.getGroupService().createGroup( group2 );
         retrievedGroup2 = eslClient.getGroupService().getGroup(createdGroup2.getId());
 
-        Group group3 = GroupBuilder.newGroup( UUID.randomUUID().toString() )
+        groupName = UUID.randomUUID().toString();
+        Group group3 = GroupBuilder.newGroup( GROUP_NAME_PREFIX + groupName )
                 .withMember( GroupMemberBuilder.newGroupMember( email3 )
                         .as( GroupMemberType.MANAGER ) )
-                .withEmail( "bob@aol.com" )
+                .withEmail( EMAIL )
                 .withIndividualMemberEmailing()
                 .build();
 
         createdGroup3 = eslClient.getGroupService().createGroup( group3 );
         retrievedGroup3 = eslClient.getGroupService().getGroup(createdGroup3.getId());
+        retrievedByNamePrefix  = eslClient.getGroupService().getMyGroups(GROUP_NAME_PREFIX);
 
-        // Here is how we delete group 2
-        eslClient.getGroupService().deleteGroup( createdGroup2.getId() );
 
         // This shows up how to update group 3
         Group groupUpdated = GroupBuilder.newGroup( UUID.randomUUID().toString() )
@@ -134,7 +144,7 @@ public void execute() {
                         .as( GroupMemberType.REGULAR ))
                 .withMember( GroupMemberBuilder.newGroupMember( email4 )
                         .as( GroupMemberType.REGULAR ))
-                .withEmail( "bob@aol.com" )
+                .withEmail( EMAIL )
                 .withIndividualMemberEmailing()
                 .build();
 
@@ -160,5 +170,10 @@ public void execute() {
         eslClient.getPackageService().notifySigner( packageId, createdGroup1.getId() );
 
         DocumentPackage result = eslClient.getPackage( packageId );
+
+        // Here is how to delete groups
+        eslClient.getGroupService().deleteGroup(createdGroup1.getId());
+        eslClient.getGroupService().deleteGroup(createdGroup2.getId());
+        eslClient.getGroupService().deleteGroup(createdGroup3.getId());
     }
 }

sdk/src/main/java/com/silanis/esl/sdk/service/GroupService.java

@@ -3,10 +3,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.silanis.esl.api.model.Result;
 import com.silanis.esl.api.util.JacksonUtil;
-import com.silanis.esl.sdk.EslException;
-import com.silanis.esl.sdk.Group;
-import com.silanis.esl.sdk.GroupId;
-import com.silanis.esl.sdk.GroupMember;
+import com.silanis.esl.sdk.*;
 import com.silanis.esl.sdk.internal.*;
 import com.silanis.esl.sdk.internal.converter.GroupConverter;
 import com.silanis.esl.sdk.internal.converter.GroupMemberConverter;
@@ -31,6 +28,21 @@ public GroupService( RestClient client, String baseUrl ) {
      */
     public List<Group> getMyGroups() {
         String path = template.urlFor( UrlTemplate.GROUPS_PATH ).build();
+        return getGroups(path);
+    }
+
+    /**
+     * Retrieve group(s) belonging to the account by specifying complete (or part of) GroupName.
+     *
+     * @param groupName
+     * @return
+     */
+    public List<Group> getMyGroups( String groupName ) {
+        String path = template.urlFor( UrlTemplate.GROUPS_PATH).addParam("name", groupName ).build();
+        return getGroups(path);
+    }
+
+    private List<Group> getGroups(String path) {
         try {
             String stringResponse = client.get( path );
             Result<com.silanis.esl.api.model.Group> apiResponse = JacksonUtil.deserialize( stringResponse, new TypeReference<Result<com.silanis.esl.api.model.Group>>() {

tester/src/test/java/com/silanis/esl/sdk/examples/GroupManagementExampleTest.java

@@ -29,6 +29,8 @@ public void verifyResult() {
         assertThat("Group 1 was not added properly", example.createdGroup1.getId(), is(example.retrievedGroup1.getId()));
         assertThat("Group 2 was not added properly", example.createdGroup2.getId(), is(example.retrievedGroup2.getId()));
         assertThat("Group 3 was not added properly", example.createdGroup3.getId(), is(example.retrievedGroup3.getId()));
+        assertThat("Group retrieval by name failed", example.createdGroup1.getName(), is(example.retrievedGroupByName1.get(0).getName()));
+        assertThat("Group retrieval by name prefix failed", example.retrievedByNamePrefix.get(0).getName().startsWith(GroupManagementExample.GROUP_NAME_PREFIX));
 
         exception.expect(EslServerException.class);
         example.getEslClient().getGroupService().getGroup(example.createdGroup2.getId());