edu.emory.cci.aiw.cvrg.eureka.services.resource

Class UserResource

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.services.resource.UserResource

public class UserResource
extends Object

RESTful end-point for UserEntity related methods.

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
UserResource(UserDao inUserDao, LocalUserDao inLocalUserDao, RoleDao inRoleDao, EmailSender inEmailSender, I2b2Client inClient, OAuthProviderDao inOAuthProviderDao, LoginTypeDao inLoginTypeDao, AuthenticationMethodDao inAuthenticationMethodDao, ServiceProperties inProperties) Create a UserResource object with a User DAO and a Role DAO.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUser(org.eurekaclinical.eureka.client.comm.User user, javax.ws.rs.core.UriInfo uriInfo) Add a new user to the system.
void	changePassword(javax.servlet.http.HttpServletRequest request, org.eurekaclinical.eureka.client.comm.PasswordChangeRequest passwordChangeRequest) Changes a user's password.
org.eurekaclinical.eureka.client.comm.User	getMe(javax.servlet.http.HttpServletRequest req) Get a user using the username.
org.eurekaclinical.eureka.client.comm.User	getUserById(javax.servlet.http.HttpServletRequest req, Long inId) Get a user by the user's identification number.
List<org.eurekaclinical.eureka.client.comm.User>	getUsers() Get a list of all users in the system.
javax.ws.rs.core.Response	putUser(javax.servlet.http.HttpServletRequest req, org.eurekaclinical.eureka.client.comm.User inUser, Long inId) Put an updated user to the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResource

@Inject
public UserResource(UserDao inUserDao,
                            LocalUserDao inLocalUserDao,
                            RoleDao inRoleDao,
                            EmailSender inEmailSender,
                            I2b2Client inClient,
                            OAuthProviderDao inOAuthProviderDao,
                            LoginTypeDao inLoginTypeDao,
                            AuthenticationMethodDao inAuthenticationMethodDao,
                            ServiceProperties inProperties)

Create a UserResource object with a User DAO and a Role DAO.

Parameters:

inUserDao - DAO used to access UserEntity related functionality.

inRoleDao - DAO used to access RoleEntity related functionality.

inEmailSender - Used to send emails to the user when necessary.

Method Detail

getUsers

@RolesAllowed(value="admin")
public List<org.eurekaclinical.eureka.client.comm.User> getUsers()

Get a list of all users in the system.

Returns:

A list of UserEntity objects.

getUserById

@RolesAllowed(value={"researcher","admin"})
public org.eurekaclinical.eureka.client.comm.User getUserById(@Context
                                                                                                          javax.servlet.http.HttpServletRequest req,
                                                                                                          Long inId)

Get a user by the user's identification number.

Parameters:

inId - The identification number for the user to fetch.

Returns:

The user referenced by the identification number.

getMe

@RolesAllowed(value={"researcher","admin"})
public org.eurekaclinical.eureka.client.comm.User getMe(@Context
                                                                                                    javax.servlet.http.HttpServletRequest req)

Get a user using the username.

Parameters:

req - The HTTP request containing the user name.

Returns:

The user corresponding to the given name.

addUser

@RolesAllowed(value="admin")
public javax.ws.rs.core.Response addUser(org.eurekaclinical.eureka.client.comm.User user,
                                                                      @Context
                                                                      javax.ws.rs.core.UriInfo uriInfo)

Add a new user to the system. The user is activated immediately.

Parameters:

user - Object containing all the information about the user to add.

changePassword

@RolesAllowed(value={"researcher","admin"})
public void changePassword(@Context
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       org.eurekaclinical.eureka.client.comm.PasswordChangeRequest passwordChangeRequest)

Changes a user's password.

Parameters:

request - the incoming servlet request

passwordChangeRequest - the request to use to make the password change

Throws:

org.eurekaclinical.standardapis.exception.HttpStatusException - Thrown when a password cannot be properly hashed, or the passwords are mismatched.

putUser

@RolesAllowed(value={"researcher","admin"})
public javax.ws.rs.core.Response putUser(@Context
                                                                                     javax.servlet.http.HttpServletRequest req,
                                                                                     org.eurekaclinical.eureka.client.comm.User inUser,
                                                                                     Long inId)

Put an updated user to the system. Unless the user has the admin role, s/he may only update their own user info.

Parameters:

inUser - Object containing all the information about the user to add.

Returns:

A "Created" response with a link to the user page if successful.