org.jbei.ice.services.rest

Class UserResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.UserResource

@Path(value="/users")
public class UserResource
extends RestResource

REST Resource for users

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
UserResource()

Method Summary

Modifier and Type	Method and Description
UserGroup	createGroup(long userId, UserGroup userGroup)
javax.ws.rs.core.Response	createNewUser(boolean sendEmail, AccountTransfer accountTransfer)
javax.ws.rs.core.Response	get(int offset, int limit, String sort, boolean asc, String filter) Retrieves list of users that are available to user making request.
List<AccountTransfer>	getAutoCompleteForAvailableAccounts(String val, int limit) Retrieves (up to specified limit), the list of users that match the value
FolderDetails	getProfileEntries(long userId, int offset, int limit, String sort, boolean asc, String filter)
javax.ws.rs.core.Response	getProfileGroups(long userId)
javax.ws.rs.core.Response	getRequestedSamples(long userId, int offset, int limit, String sort, boolean asc, long uid, SampleRequestStatus status)
UserPreferences	getUserPreferences(long userId)
javax.ws.rs.core.Response	read(String userId)
javax.ws.rs.core.Response	resetPassword(AccountTransfer transfer)
AccountTransfer	update(long userId, AccountTransfer transfer)
AccountTransfer	updatePassword(long userId, AccountTransfer transfer)
PreferenceInfo	updatePreference(long userId, String key, String value)

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

UserResource

public UserResource()

Method Detail

get

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response get(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                               int offset,
                                                                               @DefaultValue(value="15") @QueryParam(value="limit")
                                                                               int limit,
                                                                               @DefaultValue(value="lastName") @QueryParam(value="sort")
                                                                               String sort,
                                                                               @DefaultValue(value="true") @QueryParam(value="asc")
                                                                               boolean asc,
                                                                               @QueryParam(value="filter")
                                                                               String filter)

Retrieves list of users that are available to user making request. Availability is defined by being in the same group if the user does not have admin privileges.

getAutoCompleteForAvailableAccounts

@GET
 @Produces(value="application/json")
 @Path(value="/autocomplete")
public List<AccountTransfer> getAutoCompleteForAvailableAccounts(@QueryParam(value="val")
                                                                                                                                         String val,
                                                                                                                                         @DefaultValue(value="8") @QueryParam(value="limit")
                                                                                                                                         int limit)

Retrieves (up to specified limit), the list of users that match the value

Parameters:

val - text to match against users

limit - upper limit for number of users to return

Returns:

list of matching users

read

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

Returns:

account information for transfer

getProfileGroups

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

Returns:

group listing for a user

createGroup

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}/groups")
public UserGroup createGroup(@PathParam(value="id")
                                                                                                    long userId,
                                                                                                    UserGroup userGroup)

Returns:

created group

getProfileEntries

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries")
public FolderDetails getProfileEntries(@PathParam(value="id")
                                                                                                               long userId,
                                                                                                               @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                               int offset,
                                                                                                               @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                                               int limit,
                                                                                                               @DefaultValue(value="created") @QueryParam(value="sort")
                                                                                                               String sort,
                                                                                                               @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                                               boolean asc,
                                                                                                               @DefaultValue(value="") @QueryParam(value="filter")
                                                                                                               String filter)

Returns:

collection for user's part entries

getUserPreferences

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/preferences")
public UserPreferences getUserPreferences(@PathParam(value="id")
                                                                                                                      long userId)

Returns:

preferences for a user

updatePreference

@POST
 @Produces(value="application/json")
 @Path(value="/{id}/preferences/{key}")
public PreferenceInfo updatePreference(@PathParam(value="id")
                                                                                                                          long userId,
                                                                                                                          @PathParam(value="key")
                                                                                                                          String key,
                                                                                                                          @QueryParam(value="value")
                                                                                                                          String value)

Returns:

updated preferences for a user

update

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{id}")
public AccountTransfer update(@PathParam(value="id")
                                                                                                                                   long userId,
                                                                                                                                   AccountTransfer transfer)

resetPassword

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/password")
public javax.ws.rs.core.Response resetPassword(AccountTransfer transfer)

updatePassword

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{id}/password")
public AccountTransfer updatePassword(@PathParam(value="id")
                                                                                                                                                    long userId,
                                                                                                                                                    AccountTransfer transfer)

Returns:

updated user information

createNewUser

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createNewUser(@DefaultValue(value="true") @QueryParam(value="sendEmail")
                                                                                                                               boolean sendEmail,
                                                                                                                               AccountTransfer accountTransfer)

Returns:

Response with created user information

getRequestedSamples

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/samples")
public javax.ws.rs.core.Response getRequestedSamples(@PathParam(value="id")
                                                                                                                             long userId,
                                                                                                                             @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                             int offset,
                                                                                                                             @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                                                             int limit,
                                                                                                                             @DefaultValue(value="requested") @QueryParam(value="sort")
                                                                                                                             String sort,
                                                                                                                             @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                                                             boolean asc,
                                                                                                                             @PathParam(value="userId")
                                                                                                                             long uid,
                                                                                                                             @DefaultValue(value="") @QueryParam(value="status")
                                                                                                                             SampleRequestStatus status)

Returns:

Response with user's samples