Merge pull request #342 from amedviediev/master

Source code for the article "Returning Custom Status Codes from Spring MVC Controllers"

spring-rest/pom.xml

@@ -33,7 +33,6 @@
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
-            <version>${org.springframework.version}</version>
             <exclusions>
                 <exclusion>
                     <artifactId>commons-logging</artifactId>
@@ -44,12 +43,10 @@
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webmvc</artifactId>
-            <version>${org.springframework.version}</version>
         </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-oxm</artifactId>
-            <version>${org.springframework.version}</version>
         </dependency>
 
         <dependency>
@@ -229,7 +226,6 @@
 
     <properties>
         <!-- Spring -->
-        <org.springframework.version>4.2.4.RELEASE</org.springframework.version>
         <org.springframework.security.version>4.0.3.RELEASE</org.springframework.security.version>
 
         <!-- persistence -->

spring-rest/src/main/java/org/baeldung/web/controller/status/ExampleController.java

@@ -0,0 +1,24 @@
+package org.baeldung.web.controller.status;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+public class ExampleController {
+
+    @RequestMapping(value = "/controller", method = RequestMethod.GET)
+    @ResponseBody
+    public ResponseEntity sendViaResponseEntity() {
+        return new ResponseEntity(HttpStatus.NOT_ACCEPTABLE);
+    }
+
+    @RequestMapping(value = "/exception", method = RequestMethod.GET)
+    @ResponseBody
+    public ResponseEntity sendViaException() {
+        throw new ForbiddenException();
+    }
+}

spring-rest/src/main/java/org/baeldung/web/controller/status/ForbiddenException.java

@@ -0,0 +1,9 @@
+package org.baeldung.web.controller.status;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(value = HttpStatus.FORBIDDEN, reason="To show an example of a custom message")
+public class ForbiddenException extends RuntimeException {
+
+}

spring-rest/src/test/java/org/baeldung/web/controller/status/ExampleControllerTest.java

@@ -0,0 +1,44 @@
+package org.baeldung.web.controller.status;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.baeldung.config.WebConfig;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = WebConfig.class)
+@WebAppConfiguration
+public class ExampleControllerTest {
+
+    private MockMvc mockMvc;
+
+    @Autowired
+    private WebApplicationContext webApplicationContext;
+
+    @Before
+    public void setUp() {
+        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
+    }
+
+    @Test
+    public void whenGetRequestSentToController_thenReturnsStatusNotAcceptable() throws Exception {
+        mockMvc.perform(get("/controller"))
+            .andExpect(status().isNotAcceptable());
+    }
+
+    @Test
+    public void whenGetRequestSentToException_thenReturnsStatusForbidden() throws Exception {
+        mockMvc.perform(get("/exception"))
+                .andExpect(status().isForbidden());
+    }
+}