In Spring MVC, we can set the status of the HttpResponse<\/em> in several ways. In this tutorial, we\u2019ll achieve it using the @ResponseStatus<\/em> annotation.<\/p>\n We can use @ResponseStatus<\/em> to mark a method or an exception class with a status code and reason that should be returned. On invoking the marked handler method or when a specified exception is thrown, the HTTP<\/em> status will be set to the one defined using @ResponseStatus<\/em> annotation.<\/p>\n The methods in our Spring Controller, by default, return an HTTP Status 200 (OK)<\/em> on successful execution.<\/p>\n What if we want to return another type of HttpStatus<\/em> from one of our controller methods?<\/strong> To do so, we can mark it with @ResponseStatus<\/em>:<\/p>\n Optionally, we can mark our Controller<\/em> class with this annotation. For such a case, the response code configuration will be applied to all the request handler methods. We can also choose to use this annotation to mark the methods in our @ExceptionHandler<\/em> and @ControllerAdvice<\/em> beans.<\/p>\n Please note that the Spring will use @ResponseStatus<\/em> only when the marked method executes successfully without any raised exceptions.<\/strong><\/p>\n We can mark our exception class with @ResponseStatus<\/em> annotation:<\/p>\n When Spring catches such an exception, it throws the response status based on the provided settings. Note that Spring will use the same status configuration for all subclasses unless we mark them with @ResponseStatus too.<\/strong><\/p>\n Here, we have also specified the reason<\/em> of exception.<\/p>\n Spring will call a HttpServletResponse.sendError() <\/em>method when<\/em>:<\/p>\n Using sendError()<\/em> method implies that it\u2019ll generate and send an HTML<\/em> error page to the client. So when using @ResponseStatus<\/em><\/strong> in a REST<\/em> Controller method<\/strong>, we should avoid mentioning the reason<\/em>.<\/strong><\/p>\n In this quick tutorial, we looked at how we can set the status of our HttpResponse<\/em> in Spring MVC. We learned the usage of @ResponseStatus<\/em> with methods as well as exception classes.<\/p>\nWith Methods:<\/h3>\n
\n@RequestMapping(method = RequestMethod.POST)\n@ResponseStatus(HttpStatus.CREATED)\npublic void storeEmployee(@RequestBody Employee employee) {\n ...\n}\n<\/pre>\nWith Exception<\/em> Class:<\/h3>\n
\n@ReponseStatus(value = HttpStatus.FORBIDDEN, reason = \"Employee isn't authorized\")\npublic class EmployeeAccessDeniedException extends Exception {\n public EmployeeAccessDeniedException(String msg) {\n super(msg);\n }\n}\n<\/pre>\nHttpServletResponse.sendError()<\/em>:<\/h3>\n
\n
Conclusion:<\/h3>\n