Package com.JesacaLin.GrubGoblin_v13.controllers

Class UserController

java.lang.Object

com.JesacaLin.GrubGoblin_v13.controllers.UserController

@PreAuthorize("isAuthenticated()")
@RestController
@RequestMapping("/app_user")
public class UserController
extends Object

Controller for managing User entities.

Constructor Summary

Constructors

Constructor	Description
UserController(UserDAO userDAO)	Constructs a new UserController with the given UserDAO.

Method Summary

Modifier and Type	Method	Description
void	addRoleToUser(String username, String role)	Adds a role to a User.
User	createUser(User user)	Creates a new User.
int	deleteUser(String username)	Deletes a User by its username.
List<String>	getRolesForUser(String username)	Retrieves all roles for a given User.
User	getUserByUsername(String username)	Retrieves a User by its username.
List<User>	listOfUsers()	Retrieves all Users.
void	removeRoleFromUser(String username, String role)	Removes a role from a User.
User	updateUser(String username, User user, Principal principal)	Updates a User.

Methods inherited from class java.lang.Object

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

Constructor Details

UserController

public UserController(UserDAO userDAO)

Constructs a new UserController with the given UserDAO.

Parameters:

userDAO - the UserDAO to use for user management

Method Details

listOfUsers

@PreAuthorize("hasAuthority(\'admin\')")
@GetMapping("")
public List<User> listOfUsers()

Retrieves all Users.

Returns:

a list of all Users

getUserByUsername

@PreAuthorize("hasAuthority(\'contributor\') or hasAuthority(\'admin\')")
@GetMapping("/{username}")
public User getUserByUsername(@PathVariable
 String username)

Retrieves a User by its username.

Parameters:

username - the username of the User to retrieve

Returns:

the User with the given username

createUser

@PreAuthorize("hasAuthority(\'contributor\') or hasAuthority(\'admin\')")
@PostMapping
public User createUser(@RequestBody
 User user)

Creates a new User.

Parameters:

user - the User to create

Returns:

the created User

updateUser

@PreAuthorize("hasAuthority(\'contributor\') or hasAuthority(\'admin\')")
@PutMapping("/{username}")
public User updateUser(@PathVariable
 String username,
 @RequestBody
 User user,
 Principal principal)

Updates a User.

Parameters:

username - the username of the User to update

user - the User data to update

Returns:

the updated User if the authorized user is same user.

deleteUser

@PreAuthorize("hasAuthority(\'admin\')")
@DeleteMapping("/{username}")
public int deleteUser(@PathVariable
 String username)

Deletes a User by its username.

Parameters:

username - the username of the User to delete

Returns:

the number of rows affected by the delete

getRolesForUser

@PreAuthorize("hasAuthority(\'admin\')")
@GetMapping("/{username}/role")
public List<String> getRolesForUser(@PathVariable
 String username)

Retrieves all roles for a given User.

Parameters:

username - the username of the User to retrieve roles for

Returns:

a list of roles for the given User

addRoleToUser

@PreAuthorize("hasAuthority(\'admin\')")
@PostMapping("/{username}/role")
public void addRoleToUser(@PathVariable
 String username,
 @RequestBody
 String role)

Adds a role to a User.

Parameters:

username - the username of the User to add a role to

role - the role to add

removeRoleFromUser

@PreAuthorize("hasAuthority(\'admin\')")
@DeleteMapping("/{username}/role/{role}")
public void removeRoleFromUser(@PathVariable
 String username,
 @PathVariable
 String role)

Removes a role from a User.

Parameters:

username - the username of the User to remove a role from

role - the role to remove