Introduced ResponseEntity, for access to the response status code

Author: poutsma

org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerAdapter.java

@@ -61,12 +61,14 @@
 import org.springframework.http.HttpOutputMessage;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
 import org.springframework.http.converter.ByteArrayHttpMessageConverter;
 import org.springframework.http.converter.FormHttpMessageConverter;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.StringHttpMessageConverter;
 import org.springframework.http.converter.xml.SourceHttpMessageConverter;
 import org.springframework.http.server.ServerHttpRequest;
+import org.springframework.http.server.ServerHttpResponse;
 import org.springframework.http.server.ServletServerHttpRequest;
 import org.springframework.http.server.ServletServerHttpResponse;
 import org.springframework.ui.ExtendedModelMap;
@@ -895,6 +897,9 @@ private void handleHttpEntityResponse(HttpEntity<?> responseEntity, ServletWebRe
 			}
 			HttpInputMessage inputMessage = createHttpInputMessage(webRequest);
 			HttpOutputMessage outputMessage = createHttpOutputMessage(webRequest);
+			if (responseEntity instanceof ResponseEntity && outputMessage instanceof ServerHttpResponse) {
+				((ServerHttpResponse)outputMessage).setStatusCode(((ResponseEntity) responseEntity).getStatusCode());
+			}
 			HttpHeaders entityHeaders = responseEntity.getHeaders();
 			if (!entityHeaders.isEmpty()) {
 				outputMessage.getHeaders().putAll(entityHeaders);

org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/ServletAnnotationControllerTests.java

@@ -75,6 +75,7 @@
 import org.springframework.http.HttpOutputMessage;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
 import org.springframework.http.converter.ByteArrayHttpMessageConverter;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.HttpMessageNotReadableException;
@@ -1201,7 +1202,7 @@ public void httpEntity() throws ServletException, IOException {
 		request.addHeader("MyRequestHeader", "MyValue");
 		MockHttpServletResponse response = new MockHttpServletResponse();
 		servlet.service(request, response);
-		assertEquals(200, response.getStatus());
+		assertEquals(201, response.getStatus());
 		assertEquals(requestBody, response.getContentAsString());
 		assertEquals("MyValue", response.getHeader("MyResponseHeader"));
 	}
@@ -2598,15 +2599,15 @@ public void templatePath(Writer writer) throws IOException {
 	public static class HttpEntityController {
 
 		@RequestMapping("/handle")
-		public HttpEntity<String> handle(HttpEntity<byte[]> requestEntity) throws UnsupportedEncodingException {
+		public ResponseEntity<String> handle(HttpEntity<byte[]> requestEntity) throws UnsupportedEncodingException {
 			assertNotNull(requestEntity);
 			assertEquals("MyValue", requestEntity.getHeaders().getFirst("MyRequestHeader"));
 			String requestBody = new String(requestEntity.getBody(), "UTF-8");
 			assertEquals("Hello World", requestBody);
 
 			HttpHeaders responseHeaders = new HttpHeaders();
 			responseHeaders.set("MyResponseHeader", "MyValue");
-			return new HttpEntity<String>(requestBody, responseHeaders);
+			return new ResponseEntity<String>(requestBody, responseHeaders, HttpStatus.CREATED);
 		}
 	}
 

org.springframework.web/src/main/java/org/springframework/http/HttpEntity.java

@@ -16,9 +16,6 @@
 
 package org.springframework.http;
 
-import java.util.Map;
-
-import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
 
 /**
@@ -35,6 +32,15 @@
  * String body = entity.getBody();
  * MediaType contentType = entity.getHeaders().getContentType();
  * </pre>
+ * Can also be used in Spring MVC, as a return value from a @Controller method:
+ * <pre>
+ * &#64;RequestMapping("/handle")
+ * public HttpEntity&ltString&gt handle() {
+ *   HttpHeaders responseHeaders = new HttpHeaders();
+ *   responseHeaders.set("MyResponseHeader", "MyValue");
+ *   return new HttpEntity<String>("Hello World", responseHeaders);
+ * }
+ * </pre>
  *
  * @author Arjen Poutsma
  * @since 3.0.2
@@ -59,23 +65,15 @@ public class HttpEntity<T> {
 	 * Create a new, empty {@code HttpEntity}.
 	 */
 	private HttpEntity() {
-		this(null, (MultiValueMap<String, String>) null);
+		this(null, null);
 	}
 
 	/**
 	 * Create a new {@code HttpEntity} with the given body and no headers.
 	 * @param body the entity body
 	 */
 	public HttpEntity(T body) {
-		this(body, (MultiValueMap<String, String>) null);
-	}
-
-	/**
-	 * Create a new {@code HttpEntity} with the given headers and no body.
-	 * @param headers the entity headers
-	 */
-	public HttpEntity(Map<String, String> headers) {
-		this(null, toMultiValueMap(headers));
+		this(body, null);
 	}
 
 	/**
@@ -86,24 +84,6 @@ public HttpEntity(MultiValueMap<String, String> headers) {
 		this(null, headers);
 	}
 
-	/**
-	 * Create a new {@code HttpEntity} with the given body and {@code Content-Type} header value.
-	 * @param body the entity body
-	 * @param contentType the value of the {@code Content-Type header}
-	 */
-	public HttpEntity(T body, MediaType contentType) {
-		this(body, toMultiValueMap(contentType));
-	}
-
-	/**
-	 * Create a new {@code HttpEntity} with the given body and headers.
-	 * @param body the entity body
-	 * @param headers the entity headers
-	 */
-	public HttpEntity(T body, Map<String, String> headers) {
-		this(body, toMultiValueMap(headers));
-	}
-
 	/**
 	 * Create a new {@code HttpEntity} with the given body and headers.
 	 * @param body the entity body
@@ -140,27 +120,4 @@ public boolean hasBody() {
 		return (this.body != null);
 	}
 
-
-	private static MultiValueMap<String, String> toMultiValueMap(Map<String, String> map) {
-		if (map == null) {
-			return null;
-		}
-		else {
-			MultiValueMap<String, String> result = new LinkedMultiValueMap<String, String>(map.size());
-			result.setAll(map);
-			return result;
-		}
-	}
-
-	private static MultiValueMap<String, String> toMultiValueMap(MediaType contentType) {
-		if (contentType == null) {
-			return null;
-		}
-		else {
-			HttpHeaders result = new HttpHeaders();
-			result.setContentType(contentType);
-			return result;
-		}
-	}
-
 }

org.springframework.web/src/main/java/org/springframework/http/ResponseEntity.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2002-2010 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.http;
+
+import org.springframework.util.MultiValueMap;
+
+/**
+ * Extension of {@link HttpEntity} that adds a {@link HttpStatus} status code.
+ *
+ * @author Arjen Poutsma
+ * @since 3.0.2
+ * @see #getStatusCode()
+ */
+public class ResponseEntity<T> extends HttpEntity<T> {
+
+	private final HttpStatus statusCode;
+
+	/**
+	 * Create a new {@code ResponseEntity} with the given body and status code, and no headers.
+	 * @param body the entity body
+	 * @param statusCode the status code
+	 */
+	public ResponseEntity(T body, HttpStatus statusCode) {
+		super(body);
+		this.statusCode = statusCode;
+	}
+
+	/**
+	 * Create a new {@code HttpEntity} with the given headers and status code, and no body.
+	 * @param headers the entity headers
+	 * @param statusCode the status code
+	 */
+	public ResponseEntity(MultiValueMap<String, String> headers, HttpStatus statusCode) {
+		super(headers);
+		this.statusCode = statusCode;
+	}
+
+	/**
+	 * Create a new {@code HttpEntity} with the given body, headers, and status code.
+	 * @param body the entity body
+	 * @param headers the entity headers
+	 * @param statusCode the status code
+	 */
+	public ResponseEntity(T body, MultiValueMap<String, String> headers, HttpStatus statusCode) {
+		super(body, headers);
+		this.statusCode = statusCode;
+	}
+
+	/**
+	 * Return the HTTP status code of the response.
+	 * @return the HTTP status as an HttpStatus enum value
+	 */
+	public HttpStatus getStatusCode() {
+		return statusCode;
+	}
+}

org.springframework.web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java

@@ -151,7 +151,8 @@
  * to the response stream using
  * {@linkplain org.springframework.http.converter.HttpMessageConverter message
  * converters}.
- * <li>A {@link org.springframework.http.HttpEntity HttpEntity&lt;?&gt;} object
+ * <li>A {@link org.springframework.http.HttpEntity HttpEntity&lt;?&gt;} or
+ * {@link org.springframework.http.ResponseEntity ResponseEntity&lt;?&gt;} object
  * to access to the Servlet reponse HTTP headers and contents. The entity body will
  * be converted to the response stream using
  * {@linkplain org.springframework.http.converter.HttpMessageConverter message

org.springframework.web/src/main/java/org/springframework/web/client/RestOperations.java

@@ -23,6 +23,7 @@
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
 
 /**
  * Interface specifying a basic set of RESTful operations. Implemented by {@link RestTemplate}.
@@ -71,37 +72,37 @@ public interface RestOperations {
 
 	/**
 	 * Retrieve an entity by doing a GET on the specified URL.
-	 * The response is converted and stored in an {@link HttpEntity}.
+	 * The response is converted and stored in an {@link ResponseEntity}.
 	 * <p>URI Template variables are expanded using the given URI variables, if any.
 	 * @param url the URL
 	 * @param responseType the type of the return value
 	 * @param uriVariables the variables to expand the template
 	 * @return the entity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException;
+	<T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException;
 
 	/**
 	 * Retrieve a representation by doing a GET on the URI template.
-	 * The response is converted and stored in an {@link HttpEntity}.
+	 * The response is converted and stored in an {@link ResponseEntity}.
 	 * <p>URI Template variables are expanded using the given map.
 	 * @param url the URL
 	 * @param responseType the type of the return value
 	 * @param uriVariables the map containing variables for the URI template
 	 * @return the converted object
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
+	<T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
 
 	/**
 	 * Retrieve a representation by doing a GET on the URL .
-	 * The response is converted and stored in an {@link HttpEntity}.
+	 * The response is converted and stored in an {@link ResponseEntity}.
 	 * @param url the URL
 	 * @param responseType the type of the return value
 	 * @return the converted object
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException;
+	<T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException;
 
 	// HEAD
 
@@ -219,7 +220,7 @@ <T> T postForObject(String url, Object request, Class<T> responseType, Map<Strin
 
 	/**
 	 * Create a new resource by POSTing the given object to the URI template,
-	 * and returns the response as {@link HttpEntity}.
+	 * and returns the response as {@link ResponseEntity}.
 	 * <p>URI Template variables are expanded using the given URI variables, if any.
 	 * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
 	 * add additional HTTP headers to the request.
@@ -230,7 +231,7 @@ <T> T postForObject(String url, Object request, Class<T> responseType, Map<Strin
 	 * @see HttpEntity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables)
+	<T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables)
 			throws RestClientException;
 
 	/**
@@ -251,7 +252,7 @@ <T> HttpEntity<T> postForEntity(String url, Object request, Class<T> responseTyp
 
 	/**
 	 * Create a new resource by POSTing the given object to the URL,
-	 * and returns the response as {@link HttpEntity}.
+	 * and returns the response as {@link ResponseEntity}.
 	 * <p>The {@code request} parameter can be a {@link HttpEntity} in order to
 	 * add additional HTTP headers to the request.
 	 * @param url the URL
@@ -260,7 +261,7 @@ <T> HttpEntity<T> postForEntity(String url, Object request, Class<T> responseTyp
 	 * @see HttpEntity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> postForEntity(URI url, Object request, Class<T> responseType) throws RestClientException;
+	<T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> responseType) throws RestClientException;
 
 	// PUT
 
@@ -354,7 +355,7 @@ <T> HttpEntity<T> postForEntity(String url, Object request, Class<T> responseTyp
 
 	/**
 	 * Execute the HTTP method to the given URI template, writing the given request entity to the request, and
-	 * returns the response as {@link HttpEntity}.
+	 * returns the response as {@link ResponseEntity}.
 	 * <p>URI Template variables are expanded using the given URI variables, if any.
 	 * @param url the URL
 	 * @param method the HTTP method (GET, POST, etc)
@@ -364,12 +365,12 @@ <T> HttpEntity<T> postForEntity(String url, Object request, Class<T> responseTyp
 	 * @return the response as entity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity,
+	<T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity,
 			Class<T> responseType, Object... uriVariables) throws RestClientException;
 
 	/**
 	 * Execute the HTTP method to the given URI template, writing the given request entity to the request, and
-	 * returns the response as {@link HttpEntity}.
+	 * returns the response as {@link ResponseEntity}.
 	 * <p>URI Template variables are expanded using the given URI variables, if any.
 	 * @param url the URL
 	 * @param method the HTTP method (GET, POST, etc)
@@ -379,20 +380,20 @@ <T> HttpEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestE
 	 * @return the response as entity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity,
+	<T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity,
 			Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
 
 	/**
 	 * Execute the HTTP method to the given URI template, writing the given request entity to the request, and
-	 * returns the response as {@link HttpEntity}.
+	 * returns the response as {@link ResponseEntity}.
 	 * @param url the URL
 	 * @param method the HTTP method (GET, POST, etc)
 	 * @param requestEntity the entity (headers and/or body) to write to the request, may be {@code null}
 	 * @param responseType the type of the return value
 	 * @return the response as entity
 	 * @since 3.0.2
 	 */
-	<T> HttpEntity<T> exchange(URI url, HttpMethod method, HttpEntity<?> requestEntity,
+	<T> ResponseEntity<T> exchange(URI url, HttpMethod method, HttpEntity<?> requestEntity,
 			Class<T> responseType) throws RestClientException;
 
 	// general execution