Package org.exoplatform.portal.rest

Class GroupRestResourcesV1

java.lang.Object

org.exoplatform.portal.rest.GroupRestResourcesV1

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class GroupRestResourcesV1
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LIMIT
static final int	DEFAULT_OFFSET

Constructor Summary

Constructors

Constructor	Description
GroupRestResourcesV1(org.exoplatform.services.organization.OrganizationService organizationService, org.exoplatform.services.organization.search.GroupSearchService groupSearchService, UserACL userACL)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createGroup(jakarta.servlet.http.HttpServletRequest request, org.exoplatform.services.organization.impl.GroupImpl group)
javax.ws.rs.core.Response	createMembership(jakarta.servlet.http.HttpServletRequest request, org.exoplatform.services.organization.idm.MembershipImpl membership)
javax.ws.rs.core.Response	createMultipleMembership(jakarta.servlet.http.HttpServletRequest request, List<org.exoplatform.services.organization.idm.MembershipImpl> memberships)
javax.ws.rs.core.Response	deleteGroup(jakarta.servlet.http.HttpServletRequest request, String groupId)
javax.ws.rs.core.Response	deleteMembership(jakarta.servlet.http.HttpServletRequest request, String membershipId)
javax.ws.rs.core.Response	getGroupMemberships(String groupId, int offset, int limit, boolean returnSize)
javax.ws.rs.core.Response	getGroups(javax.ws.rs.core.UriInfo uriInfo, String q, int offset, int limit, boolean buildTree, boolean returnSize, String expand)
javax.ws.rs.core.Response	getGroupsTree(javax.ws.rs.core.UriInfo uriInfo, String parentId, String q, int offset, int limit, boolean returnSize)
javax.ws.rs.core.Response	getGroupsTreeMembers(javax.ws.rs.core.UriInfo uriInfo, String q, String groupMember, String groupType, int offset, int limit, boolean returnSize, boolean allGroupsForAdmin, List<String> excludeParentGroup)
javax.ws.rs.core.Response	getNestedGroups(javax.ws.rs.core.UriInfo uriInfo, String groupId, int offset, int limit, boolean returnSize)
javax.ws.rs.core.Response	updateGroup(jakarta.servlet.http.HttpServletRequest request, org.exoplatform.services.organization.impl.GroupImpl group)
javax.ws.rs.core.Response	updateMembership(jakarta.servlet.http.HttpServletRequest request, String membershipId, org.exoplatform.services.organization.idm.MembershipImpl membership)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

DEFAULT_OFFSET

public static final int DEFAULT_OFFSET

See Also:

• Constant Field Values

Constructor Details

GroupRestResourcesV1

public GroupRestResourcesV1(org.exoplatform.services.organization.OrganizationService organizationService,
 org.exoplatform.services.organization.search.GroupSearchService groupSearchService,
 UserACL userACL)

Method Details

getGroups

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getGroups(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String q,
 int offset,
 int limit,
 boolean buildTree,
 boolean returnSize,
 String expand)
                                    throws Exception

Throws:

Exception

getGroupsTree

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getGroupsTree(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String parentId,
 String q,
 int offset,
 int limit,
 boolean returnSize)
                                        throws Exception

Throws:

Exception

createGroup

@RolesAllowed("administrators")
public javax.ws.rs.core.Response createGroup(@Context
 jakarta.servlet.http.HttpServletRequest request,
 org.exoplatform.services.organization.impl.GroupImpl group)
                                      throws Exception

Throws:

Exception

updateGroup

@RolesAllowed("administrators")
public javax.ws.rs.core.Response updateGroup(@Context
 jakarta.servlet.http.HttpServletRequest request,
 org.exoplatform.services.organization.impl.GroupImpl group)
                                      throws Exception

Throws:

Exception

deleteGroup

@RolesAllowed("administrators")
public javax.ws.rs.core.Response deleteGroup(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String groupId)
                                      throws Exception

Throws:

Exception

getGroupMemberships

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getGroupMemberships(String groupId,
 int offset,
 int limit,
 boolean returnSize)
                                              throws Exception

Throws:

Exception

createMembership

@RolesAllowed("users")
public javax.ws.rs.core.Response createMembership(@Context
 jakarta.servlet.http.HttpServletRequest request,
 org.exoplatform.services.organization.idm.MembershipImpl membership)
                                           throws Exception

Throws:

Exception

createMultipleMembership

@RolesAllowed("administrators")
public javax.ws.rs.core.Response createMultipleMembership(@Context
 jakarta.servlet.http.HttpServletRequest request,
 List<org.exoplatform.services.organization.idm.MembershipImpl> memberships)
                                                   throws Exception

Throws:

Exception

updateMembership

@RolesAllowed("administrators")
public javax.ws.rs.core.Response updateMembership(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String membershipId,
 org.exoplatform.services.organization.idm.MembershipImpl membership)
                                           throws Exception

Throws:

Exception

deleteMembership

@RolesAllowed("users")
public javax.ws.rs.core.Response deleteMembership(@Context
 jakarta.servlet.http.HttpServletRequest request,
 String membershipId)
                                           throws Exception

Throws:

Exception

getGroupsTreeMembers

@RolesAllowed("users")
public javax.ws.rs.core.Response getGroupsTreeMembers(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String q,
 String groupMember,
 String groupType,
 int offset,
 int limit,
 boolean returnSize,
 boolean allGroupsForAdmin,
 List<String> excludeParentGroup)
                                               throws Exception

Throws:

Exception

getNestedGroups

@RolesAllowed("administrators")
public javax.ws.rs.core.Response getNestedGroups(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String groupId,
 int offset,
 int limit,
 boolean returnSize)
                                          throws Exception

Throws:

Exception