Package org.opencastproject.userdirectory.endpoint

Class GroupRoleEndpoint

java.lang.Object

org.opencastproject.userdirectory.endpoint.GroupRoleEndpoint

@Path("/groups")
public class GroupRoleEndpoint
extends Object

A REST EndPoint for JpaGroupRoleProvider.

Constructor Summary

Constructors

Constructor	Description
GroupRoleEndpoint()

Method Summary

Modifier and Type	Method	Description
void	activate()	Callback for activation of this component.
javax.ws.rs.core.Response	createGroup(String name, String description, String roles, String users)
javax.ws.rs.core.Response	getGroupsAsJsonOrXml(String format, int limit, int offset)
javax.ws.rs.core.Response	removeGroup(String groupId)
void	setJpaGroupRoleProvider(JpaGroupRoleProvider jpaGroupRoleProvider)
javax.ws.rs.core.Response	updateGroup(String groupId, String name, String description, String roles, String users)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupRoleEndpoint

public GroupRoleEndpoint()

Method Details

setJpaGroupRoleProvider

public void setJpaGroupRoleProvider(JpaGroupRoleProvider jpaGroupRoleProvider)

Parameters:

jpaGroupRoleProvider - the jpaGroupRoleProvider to set

activate

public void activate()

Callback for activation of this component.

getGroupsAsJsonOrXml

@GET
@Produces({"text/xml","application/json"})
@Path("groups.{format:xml|json}")
public javax.ws.rs.core.Response getGroupsAsJsonOrXml(@PathParam("format")
 String format,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)

removeGroup

@DELETE
@Path("{id}")
public javax.ws.rs.core.Response removeGroup(@PathParam("id")
 String groupId)

createGroup

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

updateGroup

@PUT
@Path("{id}")
public javax.ws.rs.core.Response updateGroup(@PathParam("id")
 String groupId,
 @FormParam("name")
 String name,
 @FormParam("description")
 String description,
 @FormParam("roles")
 String roles,
 @FormParam("users")
 String users)
                                      throws NotFoundException

Throws:

NotFoundException