edu.ucar.unidata.wmotables.controller

Class UserController

java.lang.Object

edu.ucar.unidata.wmotables.controller.UserController

All Implemented Interfaces:

org.springframework.web.servlet.HandlerExceptionResolver

@Controller
public class UserController
extends Object
implements org.springframework.web.servlet.HandlerExceptionResolver

Controller to handle and modify a User.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
UserController()

Method Summary

Methods

Modifier and Type	Method and Description
String	createUser(org.springframework.ui.Model model) Accepts a GET request to create a new User object.
org.springframework.web.servlet.ModelAndView	createUser(User user, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to create a new User object and persist it.
org.springframework.web.servlet.ModelAndView	deleteUser(User user, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to delete an existing User object.
void	initBinder(org.springframework.web.bind.WebDataBinder binder)
String	listUsers(org.springframework.ui.Model model) Accepts a GET request for a List of all User objects.
org.springframework.web.servlet.ModelAndView	resolveException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception exception) This method gracefully handles any uncaught exception that are fatal in nature and unresolvable by the user.
String	updateUser(String userName, org.springframework.ui.Model model) Accepts a GET request to update an existing User object.
org.springframework.web.servlet.ModelAndView	updateUser(User user, org.springframework.validation.BindingResult result, org.springframework.ui.Model model) Accepts a POST request to update an existing User object.
String	viewUser(String userName, org.springframework.ui.Model model) Accepts a GET request for a specific User object.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.log4j.Logger logger

Constructor Detail

UserController

public UserController()

Method Detail

initBinder

@InitBinder
public void initBinder(org.springframework.web.bind.WebDataBinder binder)

listUsers

@RequestMapping(value="/user",
                method=GET)
public String listUsers(org.springframework.ui.Model model)

Accepts a GET request for a List of all User objects. View is a list of all Users in the database. The view can handle an empty list of Users if no User objects have been persisted in the database yet.

Parameters:

model - The Model used by the View.

Returns:

The path for the ViewResolver.

viewUser

@RequestMapping(value="/user/{userName}",
                method=GET)
public String viewUser(@PathVariable
                             String userName,
                             org.springframework.ui.Model model)

Accepts a GET request for a specific User object. View is the requested User, or a list of all User objects if unable to find the requested User in the database.

Parameters:

userName - The 'userName' as provided by @PathVariable.

model - The Model used by the View.

Returns:

The path for the ViewResolver.

createUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
@RequestMapping(value="/user/create",
                method=GET)
public String createUser(org.springframework.ui.Model model)

Accepts a GET request to create a new User object. View is a web form to create the new User. Only Users with a role of 'ROLE_ADMIN' are allowed to create new User objects.

Parameters:

model - The Model used by the View.

Returns:

The path for the ViewResolver.

createUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
@RequestMapping(value="/user/create",
                method=POST)
public org.springframework.web.servlet.ModelAndView createUser(User user,
                                                                                  org.springframework.validation.BindingResult result,
                                                                                  org.springframework.ui.Model model)

Accepts a POST request to create a new User object and persist it. View is either the newly created User object, or the web form to create a new User if: 1) a User of the same user name has already exists in the database, 2) or if there are validation errors with the user input. Only Users with a role of 'ROLE_ADMIN' are allowed to create new User objects.

Parameters:

user - The User to persist.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

updateUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\') or #userName == authentication.name")
@RequestMapping(value="/user/update/{userName}",
                method=GET)
public String updateUser(@PathVariable
                                            String userName,
                                            org.springframework.ui.Model model)

Accepts a GET request to update an existing User object. View is a web form to update an existing User. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to update the User account.

Parameters:

userName - The 'userName' as provided by @PathVariable.

model - The Model used by the View.

Returns:

The path for the ViewResolver.

updateUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\') or #user.userName == authentication.name")
@RequestMapping(value="/user/update",
                method=POST)
public org.springframework.web.servlet.ModelAndView updateUser(User user,
                                                                                  org.springframework.validation.BindingResult result,
                                                                                  org.springframework.ui.Model model)

Accepts a POST request to update an existing User object. View is either the updated User object, or the web form to update the User if: 1) unable to locate the User in the database, 2) or if there are validation errors with the user input. Only the User/owner and Users with a role of 'ROLE_ADMIN' are allowed to update the User account.

Parameters:

user - The User to update.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

deleteUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
@RequestMapping(value="/user/delete",
                method=POST)
public org.springframework.web.servlet.ModelAndView deleteUser(User user,
                                                                                  org.springframework.validation.BindingResult result,
                                                                                  org.springframework.ui.Model model)

Accepts a POST request to delete an existing User object. View is either a list of all remaining User objects, or the View of the User we are trying to delete if we are unable to find the User in the database. TODO: handle tables owned by user. Only Users with a role of 'ROLE_ADMIN' are allowed to delete users.

Parameters:

user - The User to delete.

result - The BindingResult for error handling.

model - The Model used by the View.

Returns:

The redirect to the needed View.

resolveException

public org.springframework.web.servlet.ModelAndView resolveException(javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response,
                                                            Object handler,
                                                            Exception exception)

This method gracefully handles any uncaught exception that are fatal in nature and unresolvable by the user.

Specified by:

resolveException in interface org.springframework.web.servlet.HandlerExceptionResolver

Parameters:

request - The current HttpServletRequest request.

response - The current HttpServletRequest response.

handler - The executed handler, or null if none chosen at the time of the exception.

exception - The exception that got thrown during handler execution.

Returns:

The error page containing the appropriate message to the user.