Get exception object in custom error controller

Question

I am using spring boot and write a global exception handler use AbstractErrorController. How could i get an exception object in controller?

@Controller
public class MyCustomErrorController extends AbstractErrorController {

    public MyCustomErrorController(ErrorAttributes errorAttributes) {
        super(errorAttributes);
    }

    @RequestMapping("/error")
    public void handleError(HttpServletRequest req, HttpServletResponse resp) {
        Exception e = ...; // how to get exception here
        log.error(e);
        displayError(req, resp, e);
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

I don't understand the logic here. Do you want to retrieve an error from an endpoint? Usually error handlers catch an exception and return an error for any controller that thrown that exception. — Otrebor
– Otrebor, Commented Jan 21, 2019 at 15:32

trf · Accepted Answer · 2022-02-21 09:05:05Z

5

You can get the exception from the HttpServletRequest as follows:

    @Controller
    public class MyCustomErrorController extends AbstractErrorController {
    
        @RequestMapping("/error")
        public void handleError(HttpServletRequest request) {
            Exception e = (Exception) request.getAttribute(RequestDispatcher.ERROR_EXCEPTION);
            ...
        }
    }

answered Feb 21, 2022 at 9:05

trf

1,4021 gold badge15 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

BabyishTank Over a year ago

If this ErrorController pick up other error like resource not found from your database, or invalid endpoint /dsaklfja, the exception casted here is null

Jeremy Butler · Accepted Answer · 2023-06-30 08:13:41Z

1

this is how it works in Spring Boot 3.1.0. But should work in previous versions as well:

import org.springframework.web.servlet.DispatcherServlet;

   @Controller
    public class MyCustomErrorController extends AbstractErrorController {
    
        @RequestMapping("/error")
        public void handleError(HttpServletRequest request) {
                   Exception e = (Exception) request.getAttribute(DispatcherServlet.EXCEPTION_ATTRIBUTE);

            ...
        }
    }

answered Jun 30, 2023 at 8:13

Jeremy Butler

114 bronze badges

Comments

Otrebor · Accepted Answer · 2019-01-21 15:42:28Z

0

An handler intercepts an Exception generated or re-thrown by a controller. It doesn't have an endpoint because it usually does it for all the controllers in your application. The Handler instructs the application server to return a specific error when a specific Exception is thrown.

Here is an example:

@ControllerAdvice // Specialization of @Component for classes that declare @ExceptionHandler, @InitBinder, or @ModelAttribute methods to be shared across multiple @Controller classes.
public class ResourceNotFoundExceptionHandler {

@ExceptionHandler(value = { ResourceNotFoundException.class })
public ResponseEntity<Object> handleResourceNotFoundException(ResourceNotFoundException ex, WebRequest request) {
    ApiError error = new ApiError(HttpStatus.NOT_FOUND,  ex.getLocalizedMessage(), ex);

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON_UTF8);

    ResponseEntity<Object> response = new ResponseEntity<>(error, headers, HttpStatus.NOT_FOUND);

    return response;
}
}

In this example ApiError is a data structure that reports the error to the UI. What this code does is intercepting the Exception "ResourceNotFoundException", create an appropriate error Data transfer object, set the response HttpStatus and headers and return the error.

you can find a different example here: https://github.com/otrebor/springbootseed-openshift/blob/master/src/main/java/com/company/example/springbootseed/core/errorhandling/handlers/

answered Jan 21, 2019 at 15:42

Otrebor

5384 silver badges18 bronze badges

4 Comments

user1434702 Over a year ago

But ControllerAdvice dosen't catch exception from filter.

Otrebor Over a year ago

did you have a look to github.com/otrebor/springbootseed-openshift/blob/master/src/… ?

Otrebor Over a year ago

or stackoverflow.com/questions/34595605/…

BabyishTank Over a year ago

You can get the endpoint point of which ever url failed by : String url = (String) request.getAttribute(RequestDispatcher.ERROR_REQUEST_URI);

James Rodgers · Accepted Answer · 2022-05-19 10:40:31Z

0

Add Exception as an extra parameter to handleError()

answered May 19, 2022 at 10:40

James Rodgers

1

1 Comment

Community Over a year ago

As it’s currently written, your answer is unclear. Please edit to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers in the help center.

Collectives™ on Stack Overflow

Get exception object in custom error controller

4 Answers 4

1 Comment

Comments

4 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

4 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related