de.digitalcollections.cudami.server.controller.security

Class UserController

java.lang.Object

de.digitalcollections.cudami.server.controller.security.UserController

@RestController
 @Api(description="The user controller",
     name="User controller")
public class UserController
extends Object

Constructor Summary

Constructors

Constructor and Description
UserController()

Method Summary

Modifier and Type	Method and Description
de.digitalcollections.core.model.api.paging.PageResponse<User>	findAll(int pageNumber, int pageSize, String sortField, de.digitalcollections.core.model.api.paging.enums.Direction sortDirection, de.digitalcollections.core.model.api.paging.enums.NullHandling nullHandling)
User	findById(UUID uuid)
User	findByName(String email)
List<User>	getByRoleAndStatus(Role role, boolean enabled)
User	save(User user, org.springframework.validation.BindingResult errors)
User	update(UUID uuid, User user, org.springframework.validation.BindingResult errors)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserController

public UserController()

Method Detail

getByRoleAndStatus

@ApiMethod(description="get all users with given role and enabled status")
 @RequestMapping(value="/v1/users",
                params={"role","enabled"},
                produces="application/json",
                method=GET)
 @ApiResponseObject
public List<User> getByRoleAndStatus(@RequestParam(name="role")
                                                                                                                                                                                                                                                                                            Role role,
                                                                                                                                                                                                                                                                                            @RequestParam(name="enabled")
                                                                                                                                                                                                                                                                                            boolean enabled)

findAll

@ApiMethod(description="get all users")
 @RequestMapping(value="/v1/users",
                params={"pageNumber","pageSize","sortField","sortDirection","nullHandling"},
                produces="application/json",
                method={GET,POST})
 @ApiResponseObject
public de.digitalcollections.core.model.api.paging.PageResponse<User> findAll(@RequestParam(name="pageNumber",required=false)
                                                                                                                                                                                                                                                                                                                                                           int pageNumber,
                                                                                                                                                                                                                                                                                                                                                           @RequestParam(name="pageSize",required=false)
                                                                                                                                                                                                                                                                                                                                                           int pageSize,
                                                                                                                                                                                                                                                                                                                                                           @RequestParam(name="sortField",required=false)
                                                                                                                                                                                                                                                                                                                                                           String sortField,
                                                                                                                                                                                                                                                                                                                                                           @RequestParam(name="sortDirection",required=false)
                                                                                                                                                                                                                                                                                                                                                           de.digitalcollections.core.model.api.paging.enums.Direction sortDirection,
                                                                                                                                                                                                                                                                                                                                                           @RequestParam(name="nullHandling",required=false)
                                                                                                                                                                                                                                                                                                                                                           de.digitalcollections.core.model.api.paging.enums.NullHandling nullHandling)

findById

@ApiMethod(description="get user by uuid")
 @RequestMapping(value="/v1/users/{uuid}",
                produces="application/json",
                method=GET)
 @ApiResponseObject
public User findById(@PathVariable
                                                                                                                                                                                                        UUID uuid)

findByName

@ApiMethod(description="get user by email address")
 @RequestMapping(value="/v1/users",
                params="email",
                produces="application/json",
                method=GET)
 @ApiResponseObject
public User findByName(@RequestParam(name="email")
                                                                                                                                                                                                                                            String email)

save

@ApiMethod(description="save a newly created user")
 @RequestMapping(value="/v1/users",
                produces="application/json",
                method=POST)
 @ApiResponseObject
public User save(@RequestBody
                                                                                                                                                                                                       User user,
                                                                                                                                                                                                       org.springframework.validation.BindingResult errors)

update

@ApiMethod(description="update a user")
 @RequestMapping(value="/v1/users/{uuid}",
                produces="application/json",
                method=PUT)
 @ApiResponseObject
public User update(@PathVariable
                                                                                                                                                                                                   UUID uuid,
                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                   User user,
                                                                                                                                                                                                   org.springframework.validation.BindingResult errors)