io.github.jhipster.sample.web.rest

Class UserResource

java.lang.Object

io.github.jhipster.sample.web.rest.UserResource

@RestController
 @RequestMapping(value="/api")
public class UserResource
extends java.lang.Object

REST controller for managing users.

This class accesses the User entity, and needs to fetch its collection of authorities.

For a normal use-case, it would be better to have an eager relationship between User and Authority, and send everything to the client side: there would be no View Model and DTO, a lot less code, and an outer-join which would be good for performance.

We use a View Model and a DTO for 3 reasons:

• We want to keep a lazy association between the user and the authorities, because people will quite often do relationships with the user, and we don't want them to get the authorities all the time for nothing (for performance reasons). This is the #1 goal: we should not impact our users' application because of this use-case.
• Not having an outer join causes n+1 requests to the database. This is not a real issue as we have by default a second-level cache. This means on the first HTTP call we do the n+1 requests, but then all authorities come from the cache, so in fact it's much better than doing an outer join (which will get lots of data from the database, for each HTTP call).
• As this manages users, for security reasons, we'd rather have a DTO layer.

Another option would be to have a specific JPA entity graph to handle this case.

Constructor Summary

Constructors

Constructor and Description
UserResource(UserRepository userRepository, UserService userService, MailService mailService)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<User>	createUser(UserDTO userDTO) POST /users : Creates a new user.
org.springframework.http.ResponseEntity<java.lang.Void>	deleteUser(java.lang.String login) DELETE /users/:login : delete the "login" User.
org.springframework.http.ResponseEntity<java.util.List<UserDTO>>	getAllUsers(org.springframework.data.domain.Pageable pageable) GET /users : get all users.
java.util.List<java.lang.String>	getAuthorities()
org.springframework.http.ResponseEntity<UserDTO>	getUser(java.lang.String login) GET /users/:login : get the "login" user.
org.springframework.http.ResponseEntity<UserDTO>	updateUser(UserDTO userDTO) PUT /users : Updates an existing User.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResource

public UserResource(UserRepository userRepository,
                    UserService userService,
                    MailService mailService)

Method Detail

createUser

@PostMapping(value="/users")
 @Timed
 @Secured(value="ROLE_ADMIN")
public org.springframework.http.ResponseEntity<User> createUser(@RequestBody
                                                                                                                                   UserDTO userDTO)
                                                                                                                            throws java.net.URISyntaxException

POST /users : Creates a new user.

Creates a new user if the login and email are not already used, and sends an mail with an activation link. The user needs to be activated on creation.

Parameters:

userDTO - the user to create

Returns:

the ResponseEntity with status 201 (Created) and with body the new user, or with status 400 (Bad Request) if the login or email is already in use

Throws:

java.net.URISyntaxException - if the Location URI syntax is incorrect

BadRequestAlertException - 400 (Bad Request) if the login or email is already in use

updateUser

@PutMapping(value="/users")
 @Timed
 @Secured(value="ROLE_ADMIN")
public org.springframework.http.ResponseEntity<UserDTO> updateUser(@RequestBody
                                                                                                                                     UserDTO userDTO)

PUT /users : Updates an existing User.

Parameters:

userDTO - the user to update

Returns:

the ResponseEntity with status 200 (OK) and with body the updated user

Throws:

EmailAlreadyUsedException - 400 (Bad Request) if the email is already in use

LoginAlreadyUsedException - 400 (Bad Request) if the login is already in use

getAllUsers

@GetMapping(value="/users")
 @Timed
public org.springframework.http.ResponseEntity<java.util.List<UserDTO>> getAllUsers(org.springframework.data.domain.Pageable pageable)

GET /users : get all users.

Parameters:

pageable - the pagination information

Returns:

the ResponseEntity with status 200 (OK) and with body all users

getAuthorities

@GetMapping(value="/users/authorities")
 @Timed
 @Secured(value="ROLE_ADMIN")
public java.util.List<java.lang.String> getAuthorities()

Returns:

a string list of the all of the roles

getUser

@GetMapping(value="/users/{login:^[_\'.@A-Za-z0-9-]*$}")
 @Timed
public org.springframework.http.ResponseEntity<UserDTO> getUser(@PathVariable
                                                                                                                                 java.lang.String login)

GET /users/:login : get the "login" user.

Parameters:

login - the login of the user to find

Returns:

the ResponseEntity with status 200 (OK) and with body the "login" user, or with status 404 (Not Found)

deleteUser

@DeleteMapping(value="/users/{login:^[_\'.@A-Za-z0-9-]*$}")
 @Timed
 @Secured(value="ROLE_ADMIN")
public org.springframework.http.ResponseEntity<java.lang.Void> deleteUser(@PathVariable
                                                                                                                                                                            java.lang.String login)

DELETE /users/:login : delete the "login" User.

Parameters:

login - the login of the user to delete

Returns:

the ResponseEntity with status 200 (OK)