org.jbei.ice.services.rest

Class GroupResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.GroupResource

@Path(value="/groups")
public class GroupResource
extends RestResource

REST resource for groups

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
GroupResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createGroup(UserGroup userGroup)
javax.ws.rs.core.Response	deleteUserGroup(long groupId)
javax.ws.rs.core.Response	getGroup(long id) Retrieve specified group
javax.ws.rs.core.Response	getGroupMembers(long id)
javax.ws.rs.core.Response	getGroups(String type, int offset, int limit)
javax.ws.rs.core.Response	matchGroupNames(String token, int limit)
javax.ws.rs.core.Response	updateGroup(long id, UserGroup group)

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupResource

public GroupResource()

Method Detail

getGroups

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getGroups(@DefaultValue(value="PRIVATE") @QueryParam(value="type")
                                                                                     String type,
                                                                                     @QueryParam(value="offset")
                                                                                     int offset,
                                                                                     @QueryParam(value="limit")
                                                                                     int limit)

matchGroupNames

@GET
 @Produces(value="application/json")
 @Path(value="/autocomplete")
public javax.ws.rs.core.Response matchGroupNames(@QueryParam(value="token")
                                                                                                                         String token,
                                                                                                                         @DefaultValue(value="8") @QueryParam(value="limit")
                                                                                                                         int limit)

createGroup

@POST
 @Produces(value="application/json")
public javax.ws.rs.core.Response createGroup(UserGroup userGroup)

getGroup

@GET
 @Produces(value="application/json")
 @Path(value="/{id}")
public javax.ws.rs.core.Response getGroup(@PathParam(value="id")
                                                                                                          long id)

Retrieve specified group

Parameters:

id - unique identifier for group to be retrieved

Returns:

found group

deleteUserGroup

@DELETE
 @Produces(value="application/json")
 @Path(value="/{id}")
public javax.ws.rs.core.Response deleteUserGroup(@PathParam(value="id")
                                                                                                                    long groupId)

getGroupMembers

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/members")
public javax.ws.rs.core.Response getGroupMembers(@PathParam(value="id")
                                                                                                                         long id)

updateGroup

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}")
public javax.ws.rs.core.Response updateGroup(@PathParam(value="id")
                                                                                                             long id,
                                                                                                             UserGroup group)