Package org.opencastproject.adminui.endpoint

Class GroupsEndpoint

java.lang.Object

org.opencastproject.adminui.endpoint.GroupsEndpoint

@Path("/admin-ng/groups")
public class GroupsEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupsEndpoint()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	OSGi callback.
javax.ws.rs.core.Response	createGroup(String name, String description, String roles, String users)
javax.ws.rs.core.Response	getGroup(String groupId)
javax.ws.rs.core.Response	getGroups(String filter, String sort, Integer offset, Integer limit)
javax.ws.rs.core.Response	removeGroup(String groupId)
void	setGroupRoleProvider(JpaGroupRoleProvider jpaGroupRoleProvider)	OSGi callback for the group provider.
void	setIndexService(IndexService indexService)	OSGi callback for the index service.
void	setSearchIndex(ElasticsearchIndex searchIndex)	OSGi callback for the search index.
void	setSecurityService(SecurityService securityService)	OSGi callback for the security service.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGi callback for users services.
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

GroupsEndpoint

public GroupsEndpoint()

Method Details

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback for the security service.

setIndexService

public void setIndexService(IndexService indexService)

OSGi callback for the index service.

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGi callback for users services.

setSearchIndex

public void setSearchIndex(ElasticsearchIndex searchIndex)

OSGi callback for the search index.

setGroupRoleProvider

public void setGroupRoleProvider(JpaGroupRoleProvider jpaGroupRoleProvider)

OSGi callback for the group provider.

activate

protected void activate(org.osgi.service.component.ComponentContext cc)

OSGi callback.

getGroups

@GET
@Produces("application/json")
@Path("groups.json")
public javax.ws.rs.core.Response getGroups(@QueryParam("filter")
 String filter,
 @QueryParam("sort")
 String sort,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit)
                                    throws IOException

Throws:

IOException

removeGroup

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

Throws:

NotFoundException

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

getGroup

@GET
@Produces("application/json")
@Path("{id}")
public javax.ws.rs.core.Response getGroup(@PathParam("id")
 String groupId)
                                   throws NotFoundException

Throws:

NotFoundException