Trigger 404 in Spring-MVC controller

Question

How do I get a Spring 3 0 controller to trigger a 404   I have a controller with  RequestMapping value          method   RequestMethod GET  and for some URLs accessing the controller  I want the container to come up with a 404

User · Answer

Starting from Spring 5 0  you don t necessarily need to create additional exceptions   throw new ResponseStatusException NOT FOUND   Unable to find resource      Also  you can cover multiple scenarios with one  built-in exception and you have more control   See more    ResponseStatusException  javadoc  https   www baeldung com spring-response-status-exception

User · Answer

If your controller method is for something like file handling then ResponseEntity is very handy    Controller public class SomeController        RequestMapping          public ResponseEntity handleCall             if  isFound                  return new ResponseEntity                         else               return new ResponseEntity 404

User · Answer

Also if you want to return 404 status from your controller all you need is to do this   RequestMapping value     somthing   method   RequestMethod POST   ResponseBody public HttpStatus doSomthing  RequestBody String employeeId        try    return HttpStatus OK             catch Exception ex      return HttpStatus NOT FOUND            By doing this you will receive a 404 error in case when you want to return a 404 from your controller

User · Answer

Since Spring 3 0 you also can throw an Exception declared with  ResponseStatus annotation    ResponseStatus value   HttpStatus NOT FOUND  public class ResourceNotFoundException extends RuntimeException               Controller public class SomeController        RequestMapping          public void handleCall             if  isFound                     whatever                   else               throw new ResourceNotFoundException

User · Answer

I would like to mention that there s exception  not only  for 404 by default provided by Spring  See Spring documentation for details  So if you do not need your own exception you can simply do this     RequestMapping value          method   RequestMethod GET   public ModelAndView show   throws NoSuchRequestHandlingMethodException       if something    null           throw new NoSuchRequestHandlingMethodException  show   YourClass class

User · Answer

Configure web xml with setting   lt error-page gt       lt error-code gt 500 lt  error-code gt       lt location gt  error 500 lt  location gt   lt  error-page gt    lt error-page gt       lt error-code gt 404 lt  error-code gt       lt location gt  error 404 lt  location gt   lt  error-page gt    Create new controller                 Error Controller  handles the calls for 404  500 and 401 HTTP Status codes               Controller      RequestMapping value   ErrorController ERROR URL  produces   MediaType APPLICATION XHTML XML VALUE      public class ErrorController                            The constant ERROR URL                      public static final String ERROR URL     error                            The constant TILE ERROR                      public static final String TILE ERROR    error page                            Page Not Found                         return Home Page                      RequestMapping value     404   produces   MediaType APPLICATION XHTML XML VALUE          public ModelAndView notFound                  ModelAndView model   new ModelAndView TILE ERROR               model addObject  message    The page you requested could not be found  This location may not be current                  return model                                    Error page                         return the model and view                      RequestMapping value     500   produces   MediaType APPLICATION XHTML XML VALUE          public ModelAndView errorPage                 ModelAndView model   new ModelAndView TILE ERROR               model addObject  message    The page you requested could not be found  This location may not be current  due to the recent site redesign                  return model

User · Answer

Simply you can use web xml to add error code and 404 error page  But make sure 404 error page must not locate under WEB-INF    lt error-page gt       lt error-code gt 404 lt  error-code gt       lt location gt  404 html lt  location gt   lt  error-page gt    This is the simplest way to do it but this have some limitation  Suppose if you want to add the same style for this page that you added other pages  In this way you can t to that  You have to use the  ResponseStatus value   HttpStatus NOT FOUND

User · Answer

Because it s always good to have at least ten ways of doing the same thing   import org springframework http HttpStatus  import org springframework stereotype Controller  import org springframework web bind annotation RequestMapping  import org springframework web servlet ModelAndView    Controller public class Something        RequestMapping   path       public ModelAndView somethingPath             return new ModelAndView      HttpStatus NOT FOUND

User · Answer

This is a bit late  but if you are using Spring Data REST then there is already org springframework data rest webmvc ResourceNotFoundException It also uses  ResponseStatus annotation  There is no need to create a custom runtime exception anymore

User · Answer

Rewrite your method signature so that it accepts HttpServletResponse as a parameter  so that you can call setStatus int  on it   http   static springsource org spring docs 3 0 x spring-framework-reference html mvc html mvc-ann-requestmapping-arguments

User · Answer

I d recommend throwing HttpClientErrorException  like this   RequestMapping value     sample    public void sample         if  somethingIsWrong              throw new HttpClientErrorException HttpStatus NOT FOUND             You must remember that this can be done only before anything is written to servlet output stream

User · Answer

While the marked answer is correct there is a way of achieving this without exceptions  The service is returning Optional lt T gt  of the searched object and this is mapped to HttpStatus OK if found and to  404 if empty     Controller public class SomeController         RequestMapping          public ResponseEntity lt Object gt  handleCall             return  service find param  map result - gt  new ResponseEntity lt  gt  result  HttpStatus OK                    orElse new ResponseEntity lt  gt  HttpStatus NOT FOUND              Service public class Service       public Optional lt Object gt  find String param           if  found                 return Optional empty                                  return Optional of data

User · Answer

you can use the  ControllerAdvice to handle your Exceptions   The default behavior the  ControllerAdvice annotated class will assist all known Controllers   so it will be called when any Controller you have throws 404 error    like the following      ControllerAdvice class GlobalControllerExceptionHandler        ResponseStatus HttpStatus NOT FOUND      404      ExceptionHandler Exception class      public void handleNoTFound                Nothing to do           and map this 404 response error in your web xml   like the following      lt error-page gt           lt error-code gt 404 lt  error-code gt           lt location gt  Error404 html lt  location gt   lt  error-page gt    Hope that Helps

User · Answer

Since Spring 3 0 2 you can return ResponseEntity lt T gt  as a result of the controller s method    RequestMapping      public ResponseEntity lt Object gt  handleCall         if  isFound                 do what you want         return new ResponseEntity lt  gt  HttpStatus OK             else           return new ResponseEntity lt  gt  HttpStatus NOT FOUND              ResponseEntity lt T gt  is a more flexible than  ResponseBody annotation - see another question

[java] Trigger 404 in Spring-MVC controller?

Examples related to java

Examples related to spring

Examples related to spring-mvc