Merged 5.2.N (5.2.2) to HEAD (5.2)

133574 cturlica: REPO-1302: Retrieve list of group members
      - added group members api
      - fixed order by issue when using post processing ordering by id


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

source/java/org/alfresco/rest/api/Groups.java

@@ -26,6 +26,7 @@
 package org.alfresco.rest.api;
 
 import org.alfresco.rest.api.model.Group;
+import org.alfresco.rest.api.model.GroupMember;
 import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
 import org.alfresco.rest.framework.resource.parameters.Parameters;
 
@@ -41,6 +42,9 @@ public interface Groups
     String PARAM_INCLUDE_PARENT_IDS = "parentIds";
     String PARAM_INCLUDE_ZONES = "zones";
     String PARAM_IS_ROOT = "isRoot";
+    String PARAM_MEMBER_TYPE = "memberType";
+    String PARAM_MEMBER_TYPE_GROUP = "GROUP";
+    String PARAM_MEMBER_TYPE_PERSON = "PERSON";
 
     /**
      * Gets a list of groups.
@@ -53,4 +57,15 @@ public interface Groups
      */
     CollectionWithPagingInfo<Group> getGroups(Parameters parameters);
 
+    /**
+     * Gets a list of groups.
+     *
+     * @param groupId the identifier of a group.
+     * @param parameters the {@link Parameters} object to get the parameters passed into the request
+     *        including:
+     *        - filter, sort & paging params (where, orderBy, skipCount, maxItems)
+     *        - incFiles, incFolders (both true by default)
+     * @return a paged list of {@code org.alfresco.rest.api.model.GroupMember} objects
+     */
+    CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, Parameters parameters);
 }

source/java/org/alfresco/rest/api/groups/GroupMembersRelation.java

@@ -0,0 +1,64 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.groups;
+
+import org.alfresco.rest.api.Groups;
+import org.alfresco.rest.api.model.GroupMember;
+import org.alfresco.rest.framework.WebApiDescription;
+import org.alfresco.rest.framework.resource.RelationshipResource;
+import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
+import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.util.ParameterCheck;
+import org.springframework.beans.factory.InitializingBean;
+
+/**
+
+ * @author cturlica
+ */
+@RelationshipResource(name = "members", entityResource = GroupsEntityResource.class, title = "Group Members")
+public class GroupMembersRelation implements RelationshipResourceAction.Read<GroupMember>, InitializingBean
+{
+    private Groups groups;
+
+    public void setGroups(Groups groups)
+    {
+        this.groups = groups;
+    }
+
+    @Override
+    public void afterPropertiesSet()
+    {
+        ParameterCheck.mandatory("groups", this.groups);
+    }
+
+    @Override
+    @WebApiDescription(title="A paged list of all the members of the group 'groupId'.")
+    public CollectionWithPagingInfo<GroupMember> readAll(String groupId, Parameters params)
+    {
+        return groups.getGroupMembers(groupId, params);
+    }
+}

source/java/org/alfresco/rest/api/impl/GroupsImpl.java

@@ -47,6 +47,7 @@ import org.alfresco.repo.security.authority.UnknownAuthorityException;
 import org.alfresco.rest.antlr.WhereClauseParser;
 import org.alfresco.rest.api.Groups;
 import org.alfresco.rest.api.model.Group;
+import org.alfresco.rest.api.model.GroupMember;
 import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
 import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
@@ -85,6 +86,8 @@ public class GroupsImpl implements Groups
     // List groups filtering (via where clause)
     private final static Set<String> LIST_GROUPS_EQUALS_QUERY_PROPERTIES = new HashSet<>(Arrays.asList(new String[] { PARAM_IS_ROOT }));
 
+    private final static Set<String> LIST_GROUP_MEMBERS_QUERY_PROPERTIES = new HashSet<>(Arrays.asList(new String[] { PARAM_MEMBER_TYPE }));
+
     protected AuthorityService authorityService;
 
     public AuthorityService getAuthorityService()
@@ -355,11 +358,11 @@ public class GroupsImpl implements Groups
             if (v == null)
             {
                 // Get the value from the group
-                if (PARAM_DISPLAY_NAME.equals(sortBy))
+                if (DISPLAY_NAME.equals(sortBy))
                 {
                     v = g.getAuthorityDisplayName();
                 }
-                else if (PARAM_ID.equals(sortBy))
+                else if (SHORT_NAME.equals(sortBy))
                 {
                     v = g.getAuthorityName();
                 }
@@ -377,4 +380,131 @@ public class GroupsImpl implements Groups
             return v;
         }
     }
+
+    public CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, final Parameters parameters)
+    {
+        validateGroupId(groupId);
+
+        Paging paging = parameters.getPaging();
+
+        // Retrieve sort column. This is limited for now to sort column due to
+        // v0 api implementation. Should be improved in the future.
+        Pair<String, Boolean> sortProp = getGroupsSortProp(parameters);
+
+        AuthorityType authorityType = null;
+
+        // Parse where clause properties.
+        Query q = parameters.getQuery();
+        if (q != null)
+        {
+            MapBasedQueryWalkerOrSupported propertyWalker = new MapBasedQueryWalkerOrSupported(LIST_GROUP_MEMBERS_QUERY_PROPERTIES, null);
+            QueryHelper.walk(q, propertyWalker);
+
+            String memberTypeStr = propertyWalker.getProperty(PARAM_MEMBER_TYPE, WhereClauseParser.EQUALS, String.class);
+
+            if (memberTypeStr != null && !memberTypeStr.isEmpty())
+            {
+                switch (memberTypeStr)
+                {
+                case PARAM_MEMBER_TYPE_GROUP:
+                    authorityType = AuthorityType.GROUP;
+                    break;
+                case PARAM_MEMBER_TYPE_PERSON:
+                    authorityType = AuthorityType.USER;
+                    break;
+                default:
+                    throw new InvalidArgumentException("MemberType is invalid (expected eg. GROUP, PERSON)");
+                }
+            }
+        }
+
+        PagingResults<AuthorityInfo> pagingResult = getAuthoritiesInfo(authorityType, groupId, sortProp, paging);
+
+        // Create response.
+        final List<AuthorityInfo> page = pagingResult.getPage();
+        int totalItems = pagingResult.getTotalResultCount().getFirst();
+        List<GroupMember> groupMembers = new AbstractList<GroupMember>()
+        {
+            @Override
+            public GroupMember get(int index)
+            {
+                AuthorityInfo authorityInfo = page.get(index);
+                return getGroupMember(authorityInfo);
+            }
+
+            @Override
+            public int size()
+            {
+                return page.size();
+            }
+        };
+
+        return CollectionWithPagingInfo.asPaged(paging, groupMembers, pagingResult.hasMoreItems(), totalItems);
+    }
+
+    private PagingResults<AuthorityInfo> getAuthoritiesInfo(AuthorityType authorityType, String groupId, Pair<String, Boolean> sortProp, Paging paging)
+    {
+        Set<String> authorities;
+        try
+        {
+            authorities = authorityService.findAuthorities(authorityType, groupId, true, null, null);
+        }
+        catch (UnknownAuthorityException e)
+        {
+            authorities = Collections.emptySet();
+        }
+
+        List<AuthorityInfo> authorityInfoList = new ArrayList<>(authorities.size());
+        authorityInfoList.addAll(authorities.stream().map(this::getAuthorityInfo).collect(Collectors.toList()));
+
+        // Post process sorting - this should be moved to service
+        // layer. It is done here because sorting is not supported at
+        // service layer.
+        AuthorityInfoComparator authorityComparator = new AuthorityInfoComparator(sortProp.getFirst(), sortProp.getSecond());
+        Collections.sort(authorityInfoList, authorityComparator);
+
+        // Post process paging - this should be moved to service layer.
+        return Util.wrapPagingResults(paging, authorityInfoList);
+    }
+
+    private GroupMember getGroupMember(AuthorityInfo authorityInfo)
+    {
+        if (authorityInfo == null)
+        {
+            return null;
+        }
+
+        GroupMember groupMember = new GroupMember();
+        groupMember.setId(authorityInfo.getAuthorityName());
+        groupMember.setDisplayName(authorityInfo.getAuthorityDisplayName());
+
+        String memberType = null;
+        AuthorityType authorityType = AuthorityType.getAuthorityType(authorityInfo.getAuthorityName());
+        switch (authorityType)
+        {
+        case GROUP:
+            memberType = PARAM_MEMBER_TYPE_GROUP;
+            break;
+        case USER:
+            memberType = PARAM_MEMBER_TYPE_PERSON;
+            break;
+        default:
+        }
+        groupMember.setMemberType(memberType);
+
+        return groupMember;
+    }
+
+    private void validateGroupId(String groupId)
+    {
+        if (groupId == null || groupId.isEmpty())
+        {
+            throw new InvalidArgumentException("groupId is null or empty");
+        }
+
+        if (!authorityService.authorityExists(groupId))
+        {
+            throw new EntityNotFoundException(groupId);
+        }
+    }
 }

source/java/org/alfresco/rest/api/model/GroupMember.java

@@ -0,0 +1,116 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.model;
+
+import org.alfresco.rest.framework.resource.UniqueId;
+
+/**
+ * Represents a group member.
+ * 
+ * @author cturlica
+ *
+ */
+public class GroupMember implements Comparable<GroupMember>
+{
+
+    private String id; // group id (aka authority name)
+    private String displayName;
+    private String memberType;
+
+    @UniqueId
+    public String getId()
+    {
+        return id;
+    }
+
+    public void setId(String id)
+    {
+        this.id = id;
+    }
+
+    public String getDisplayName()
+    {
+        return displayName;
+    }
+
+    public void setDisplayName(String displayName)
+    {
+        this.displayName = displayName;
+    }
+
+    public String getMemberType()
+    {
+        return memberType;
+    }
+
+    public void setMemberType(String memberType)
+    {
+        this.memberType = memberType;
+    }
+
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (this == obj)
+        {
+            return true;
+        }
+
+        if (obj == null)
+        {
+            return false;
+        }
+
+        if (getClass() != obj.getClass())
+        {
+            return false;
+        }
+
+        GroupMember other = (GroupMember) obj;
+        return id.equals(other.id);
+    }
+
+    @Override
+    public int compareTo(GroupMember group)
+    {
+        return id.compareTo(group.getId());
+    }
+
+    @Override
+    public int hashCode()
+    {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((id == null) ? 0 : id.hashCode());
+        return result;
+    }
+
+    @Override
+    public String toString()
+    {
+        return "GroupMember [id=" + id + ", displayName=" + displayName + ", memberType=" + memberType + "]";
+    }
+}