package com.mycompany.myapp.web.rest;
import com.codahale.metrics.annotation.Timed;
import com.mycompany.myapp.domain.Authority;
import com.mycompany.myapp.domain.User;
import com.mycompany.myapp.repository.AuthorityRepository;
import com.mycompany.myapp.repository.UserRepository;
import com.mycompany.myapp.security.AuthoritiesConstants;
import com.mycompany.myapp.service.MailService;
import com.mycompany.myapp.service.UserService;
import com.mycompany.myapp.web.rest.dto.ManagedUserDTO;
import com.mycompany.myapp.web.rest.dto.UserDTO;
import com.mycompany.myapp.web.rest.util.HeaderUtil;
import com.mycompany.myapp.web.rest.util.PaginationUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.annotation.Secured;
import org.springframework.web.bind.annotation.*;
import javax.inject.Inject;
import java.net.URI;
import java.net.URISyntaxException;
import javax.servlet.http.HttpServletRequest;
import java.util.*;
import java.util.stream.Collectors;
/**
* REST controller for managing users.
*
* <p>This class accesses the User entity, and needs to fetch its collection of authorities.</p>
* <p>
* 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 DTO, a lot less code, and an outer-join
* which would be good for performance.
* </p>
* <p>
* We use a DTO for 3 reasons:
* <ul>
* <li>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.</li>
* <li> 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).</li>
* <li> As this manages users, for security reasons, we'd rather have a DTO layer.</li>
* </p>
* <p>Another option would be to have a specific JPA entity graph to handle this case.</p>
*/
@RestController
@RequestMapping("/api")
public class UserResource {
private final Logger log = LoggerFactory.getLogger(UserResource.class);
@Inject
private UserRepository userRepository;
@Inject
private MailService mailService;
@Inject
private AuthorityRepository authorityRepository;
@Inject
private UserService userService;
/**
* POST /users -> Creates a new user.
* <p>
* 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.
* </p>
*/
@RequestMapping(value = "/users",
method = RequestMethod.POST,
produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
@Secured(AuthoritiesConstants.ADMIN)
public ResponseEntity<?> createUser(@RequestBody ManagedUserDTO managedUserDTO, HttpServletRequest request) throws URISyntaxException {
log.debug("REST request to save User : {}", managedUserDTO);
if (Optional.ofNullable(userRepository.findOneByLogin(managedUserDTO.getLogin())).isPresent()) {
return ResponseEntity.badRequest()
.headers(HeaderUtil.createFailureAlert("user-management", "userexists", "Login already in use"))
.body(null);
} else if (Optional.ofNullable(userRepository.findOneByEmail(managedUserDTO.getEmail())).isPresent()) {
return ResponseEntity.badRequest()
.headers(HeaderUtil.createFailureAlert("user-management", "emailexists", "Email already in use"))
.body(null);
} else {
User newUser = userService.createUser(managedUserDTO);
String baseUrl = request.getScheme() + // "http"
"://" + // "://"
request.getServerName() + // "myhost"
":" + // ":"
request.getServerPort() + // "80"
request.getContextPath(); // "/myContextPath" or "" if deployed in root context
mailService.sendCreationEmail(newUser, baseUrl);
return ResponseEntity.created(new URI("/api/users/" + newUser.getLogin()))
.headers(HeaderUtil.createAlert( "user-management.created", newUser.getLogin()))
.body(newUser);
}
}
/**
* PUT /users -> Updates an existing User.
*/
@RequestMapping(value = "/users",
method = RequestMethod.PUT,
produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
@Secured(AuthoritiesConstants.ADMIN)
public ResponseEntity<ManagedUserDTO> updateUser(@RequestBody ManagedUserDTO managedUserDTO) throws URISyntaxException {
log.debug("REST request to update User : {}", managedUserDTO);
Optional<User> existingUser = Optional.ofNullable(userRepository.findOneByEmail(managedUserDTO.getEmail()));
if (existingUser.isPresent() && (!existingUser.get().getId().equals(managedUserDTO.getId()))) {
return ResponseEntity.badRequest().headers(HeaderUtil.createFailureAlert("user-management", "emailexists", "E-mail already in use")).body(null);
}
existingUser = Optional.ofNullable(userRepository.findOneByLogin(managedUserDTO.getLogin()));
if (existingUser.isPresent() && (!existingUser.get().getId().equals(managedUserDTO.getId()))) {
return ResponseEntity.badRequest().headers(HeaderUtil.createFailureAlert("user-management", "userexists", "Login already in use")).body(null);
}
return Optional.ofNullable(userRepository
.findOneById(managedUserDTO.getId()))
.map(user -> {
user.setLogin(managedUserDTO.getLogin());
user.setFirstName(managedUserDTO.getFirstName());
user.setLastName(managedUserDTO.getLastName());
user.setEmail(managedUserDTO.getEmail());
user.setActivated(managedUserDTO.isActivated());
user.setLangKey(managedUserDTO.getLangKey());
Set<Authority> authorities = user.getAuthorities();
authorities.clear();
managedUserDTO.getAuthorities().stream().forEach(
authority -> authorities.add(authorityRepository.findOneByName(authority))
);
userRepository.save(user);
return ResponseEntity.ok()
.headers(HeaderUtil.createAlert("user-management.updated", managedUserDTO.getLogin()))
.body(new ManagedUserDTO(userRepository
.findOne(Long.parseLong(managedUserDTO.getId()))));
})
.orElseGet(() -> new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR));
}
/**
* GET /users -> get all users.
*/
@RequestMapping(value = "/users",
method = RequestMethod.GET,
produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
public ResponseEntity<List<ManagedUserDTO>> getAllUsers(Pageable pageable)
throws URISyntaxException {
Page<User> page = userRepository.findAll(pageable);
List<ManagedUserDTO> managedUserDTOs = page.getContent().stream()
.map(user -> new ManagedUserDTO(user))
.collect(Collectors.toList());
HttpHeaders headers = PaginationUtil.generatePaginationHttpHeaders(page, "/api/users");
return new ResponseEntity<>(managedUserDTOs, headers, HttpStatus.OK);
}
/**
* GET /users/:login -> get the "login" user.
*/
@RequestMapping(value = "/users/{login:[_'.@a-z0-9-]+}",
method = RequestMethod.GET,
produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
public ResponseEntity<ManagedUserDTO> getUser(@PathVariable String login) {
log.debug("REST request to get User : {}", login);
return userService.getUserWithAuthoritiesByLogin(login)
.map(ManagedUserDTO::new)
.map(managedUserDTO -> new ResponseEntity<>(managedUserDTO, HttpStatus.OK))
.orElse(new ResponseEntity<>(HttpStatus.NOT_FOUND));
}
/**
* DELETE USER :login -> delete the "login" User.
*/
@RequestMapping(value = "/users/{login}",
method = RequestMethod.DELETE,
produces = MediaType.APPLICATION_JSON_VALUE)
@Timed
@Secured(AuthoritiesConstants.ADMIN)
public ResponseEntity<Void> deleteUser(@PathVariable String login) {
log.debug("REST request to delete User: {}", login);
userService.deleteUserInformation(login);
return ResponseEntity.ok().headers(HeaderUtil.createAlert( "user-management.deleted", login)).build();
}
}