org.finra.herd.ui.controller

Class HerdUiControllerAdvice

java.lang.Object

org.finra.herd.ui.controller.HerdUiControllerAdvice

@ControllerAdvice(value="org.finra.herd.ui.controller")
public class HerdUiControllerAdvice
extends Object

A general form controller advice that can be used to handle UI controller exceptions.

Constructor Summary

Constructors

Constructor and Description
HerdUiControllerAdvice()

Method Summary

Modifier and Type	Method and Description
static org.springframework.web.servlet.ModelAndView	getDisplayErrorMessageModelAndView(String message) Gets a "displayErrorMessage" model and view.
static org.springframework.web.servlet.ModelAndView	getDisplayErrorModelAndView() Gets a "displayError" model and view with no model present.
void	handleAccessDeniedException(org.springframework.security.access.AccessDeniedException accessDeniedException, javax.servlet.http.HttpServletResponse response)
org.springframework.web.servlet.ModelAndView	handleException(Exception ex) Handle all other controller exceptions by returning to a general error page with a general message.
org.springframework.web.servlet.ModelAndView	handleUserException(UserException ex) Handle all user exceptions by returning to a general error page while displaying the exception message to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

HerdUiControllerAdvice

public HerdUiControllerAdvice()

Method Detail

handleUserException

@ExceptionHandler(value=UserException.class)
public org.springframework.web.servlet.ModelAndView handleUserException(UserException ex)

Handle all user exceptions by returning to a general error page while displaying the exception message to the user. A "message" model is returned.

Parameters:

ex - the exception being handled.

Returns:

the model and view to the error page.

handleAccessDeniedException

@ExceptionHandler(value=org.springframework.security.access.AccessDeniedException.class)
public void handleAccessDeniedException(org.springframework.security.access.AccessDeniedException accessDeniedException,
                                                                                                                                 javax.servlet.http.HttpServletResponse response)
                                                                                                                          throws IOException

Throws:

IOException

handleException

@ExceptionHandler(value=java.lang.Exception.class)
public org.springframework.web.servlet.ModelAndView handleException(Exception ex)

Handle all other controller exceptions by returning to a general error page with a general message. The exception message isn't displayed to the user for security reasons. A "message" model is returned.

Parameters:

ex - the exception being handled.

Returns:

the model and view to the error page.

getDisplayErrorModelAndView

public static org.springframework.web.servlet.ModelAndView getDisplayErrorModelAndView()

Gets a "displayError" model and view with no model present.

Returns:

the model and view.

getDisplayErrorMessageModelAndView

public static org.springframework.web.servlet.ModelAndView getDisplayErrorMessageModelAndView(String message)

Gets a "displayErrorMessage" model and view.

Parameters:

message - An optional error message to include in the model. If null, it won't be included in the model. The message will be automatically HTML escaped.

Returns:

the model and view.