Package org.opencastproject.external.endpoint

Class GroupsEndpoint

java.lang.Object

org.opencastproject.external.endpoint.GroupsEndpoint

@Path("/api/groups")
@Produces({"application/json","application/v1.0.0+json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"})
public class GroupsEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupsEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addGroupMember(String acceptHeader, String id, String member)
javax.ws.rs.core.Response	createGroup(String acceptHeader, String name, String description, String roles, String members)
javax.ws.rs.core.Response	deleteGroup(String acceptHeader, String id)
javax.ws.rs.core.Response	getGroup(String acceptHeader, String id)
javax.ws.rs.core.Response	getGroups(String acceptHeader, String filter, String sort, Integer offset, Integer limit)
javax.ws.rs.core.Response	removeGroupMember(String acceptHeader, String id, String memberId)
void	setGroupRoleProvider(org.opencastproject.userdirectory.JpaGroupRoleProvider jpaGroupRoleProvider)	OSGi DI
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	OSGi DI.
javax.ws.rs.core.Response	updateGroup(String acceptHeader, String id, String name, String description, String roles, String members)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupsEndpoint

public GroupsEndpoint()

Method Details

setSecurityService

public void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

OSGi DI.

setGroupRoleProvider

public void setGroupRoleProvider(org.opencastproject.userdirectory.JpaGroupRoleProvider jpaGroupRoleProvider)

OSGi DI

getGroups

@GET
@Path("")
public javax.ws.rs.core.Response getGroups(@HeaderParam("Accept")
 String acceptHeader,
 @QueryParam("filter")
 String filter,
 @QueryParam("sort")
 String sort,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit)

getGroup

@GET
@Path("{groupId}")
public javax.ws.rs.core.Response getGroup(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("groupId")
 String id)

deleteGroup

@DELETE
@Path("{groupId}")
public javax.ws.rs.core.Response deleteGroup(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("groupId")
 String id)
                                      throws org.opencastproject.util.NotFoundException

Throws:

org.opencastproject.util.NotFoundException

updateGroup

@PUT
@Path("{groupId}")
public javax.ws.rs.core.Response updateGroup(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("groupId")
 String id,
 @FormParam("name")
 String name,
 @FormParam("description")
 String description,
 @FormParam("roles")
 String roles,
 @FormParam("members")
 String members)
                                      throws Exception

Throws:

Exception

createGroup

@POST
@Path("")
public javax.ws.rs.core.Response createGroup(@HeaderParam("Accept")
 String acceptHeader,
 @FormParam("name")
 String name,
 @FormParam("description")
 String description,
 @FormParam("roles")
 String roles,
 @FormParam("members")
 String members)

addGroupMember

@POST
@Path("{groupId}/members")
public javax.ws.rs.core.Response addGroupMember(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("groupId")
 String id,
 @FormParam("member")
 String member)

removeGroupMember

@DELETE
@Path("{groupId}/members/{memberId}")
public javax.ws.rs.core.Response removeGroupMember(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("groupId")
 String id,
 @PathParam("memberId")
 String memberId)