SPR-6301 - Support @RequestHeader on HttpHeaders parameters

Author: poutsma

org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletWebRequest.java

@@ -96,6 +96,10 @@ public String[] getHeaderValues(String headerName) {
 		return (!ObjectUtils.isEmpty(headerValues) ? headerValues : null);
 	}
 
+	public Iterator<String> getHeaderNames() {
+		return CollectionUtils.toIterator(getRequest().getPropertyNames());
+	}
+
 	public String getParameter(String paramName) {
 		return getRequest().getParameter(paramName);
 	}

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

@@ -66,6 +66,7 @@
 import org.springframework.http.HttpOutputMessage;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
+import org.springframework.http.HttpHeaders;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.http.converter.HttpMessageNotWritableException;
@@ -1134,6 +1135,31 @@ public void requestParamMap() throws Exception {
 		assertEquals("key1=[value1],key2=[value21,value22]", response.getContentAsString());
 	}
 
+	@Test
+	public void requestHeaderMap() throws Exception {
+		initServlet(RequestHeaderMapController.class);
+
+		MockHttpServletRequest request = new MockHttpServletRequest("GET", "/map");
+		request.addHeader("Content-Type", "text/html");
+		request.addHeader("Custom-Header", new String[]{"value21", "value22"});
+		MockHttpServletResponse response = new MockHttpServletResponse();
+
+		servlet.service(request, response);
+		assertEquals("Content-Type=text/html,Custom-Header=value21", response.getContentAsString());
+
+		request.setRequestURI("/multiValueMap");
+		response = new MockHttpServletResponse();
+
+		servlet.service(request, response);
+		assertEquals("Content-Type=[text/html],Custom-Header=[value21,value22]", response.getContentAsString());
+
+		request.setRequestURI("/httpHeaders");
+		response = new MockHttpServletResponse();
+
+		servlet.service(request, response);
+		assertEquals("Content-Type=[text/html],Custom-Header=[value21,value22]", response.getContentAsString());
+	}
+
 
 	/*
 	 * Controllers
@@ -1965,6 +1991,48 @@ public void multiValueMap(@RequestParam MultiValueMap<String, String> params, Wr
 			}
 		}
 	}
-	
+
+	@Controller
+	public static class RequestHeaderMapController {
+
+		@RequestMapping("/map")
+		public void map(@RequestHeader Map<String, String> headers, Writer writer) throws IOException {
+			for (Iterator<Map.Entry<String, String>> it = headers.entrySet().iterator(); it.hasNext();) {
+				Map.Entry<String, String> entry = it.next();
+				writer.write(entry.getKey() + "=" + entry.getValue());
+				if (it.hasNext()) {
+					writer.write(',');
+				}
+
+			}
+		}
+
+		@RequestMapping("/multiValueMap")
+		public void multiValueMap(@RequestHeader MultiValueMap<String, String> headers, Writer writer) throws IOException {
+			for (Iterator<Map.Entry<String, List<String>>> it1 = headers.entrySet().iterator(); it1.hasNext();) {
+				Map.Entry<String, List<String>> entry = it1.next();
+				writer.write(entry.getKey() + "=[");
+				for (Iterator<String> it2 = entry.getValue().iterator(); it2.hasNext();) {
+					String value = it2.next();
+					writer.write(value);
+					if (it2.hasNext()) {
+						writer.write(',');
+					}
+				}
+				writer.write(']');
+				if (it1.hasNext()) {
+					writer.write(',');
+				}
+			}
+		}
+
+		@RequestMapping("/httpHeaders")
+		public void httpHeaders(@RequestHeader HttpHeaders headers, Writer writer) throws IOException {
+			assertEquals("Invalid Content-Type", new MediaType("text", "html"), headers.getContentType());
+			multiValueMap(headers, writer);
+		}
+
+	}
+
 
 }

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

@@ -77,12 +77,16 @@
  * <li>{@link RequestParam @RequestParam} annotated parameters for access to
  * specific Servlet/Portlet request parameters. Parameter values will be
  * converted to the declared method argument type. Additionally,
- * {@code RequestParam @RequestParam} can be used on a {@link java.util.Map Map} or
- * {@link org.springframework.util.MultiValueMap MultiValueMap} to gain access
- * to all request parameters. 
+ * {@code @RequestParam} can be used on a {@link java.util.Map Map&lt;String, String&gt;} or
+ * {@link org.springframework.util.MultiValueMap MultiValueMap&lt;String, String&gt;}
+ * method parameter to gain access to all request parameters.
  * <li>{@link RequestHeader @RequestHeader} annotated parameters for access to
  * specific Servlet/Portlet request HTTP headers. Parameter values will be
- * converted to the declared method argument type.
+ * converted to the declared method argument type. Additionally,
+ * {@code @RequestHeader} can be used on a {@link java.util.Map Map&lt;String, String&gt;},
+ * {@link org.springframework.util.MultiValueMap MultiValueMap&lt;String, String&gt;}, or
+ * {@link org.springframework.http.HttpHeaders HttpHeaders} method parameter to
+ * gain access to all request headers.
  * <li>{@link RequestBody @RequestBody} annotated parameters for access to
  * the Servlet request HTTP contents. Parameter values will be
  * converted to the declared method argument type using 

org.springframework.web/src/main/java/org/springframework/web/bind/annotation/support/HandlerMethodInvoker.java

@@ -27,6 +27,7 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.LinkedHashMap;
+import java.util.Iterator;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -41,6 +42,7 @@
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.http.HttpInputMessage;
 import org.springframework.http.MediaType;
+import org.springframework.http.HttpHeaders;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.ui.ExtendedModelMap;
 import org.springframework.ui.Model;
@@ -457,11 +459,15 @@ private Map resolveRequestParamMap(Class<? extends Map> mapType, NativeWebReques
 		}
 	}
 
+	@SuppressWarnings("unchecked")
 	private Object resolveRequestHeader(String headerName, boolean required, String defaultValue,
 			MethodParameter methodParam, NativeWebRequest webRequest, Object handlerForInitBinderCall)
 			throws Exception {
 
 		Class<?> paramType = methodParam.getParameterType();
+		if (Map.class.isAssignableFrom(paramType)) {
+			return resolveRequestHeaderMap((Class<? extends Map>) paramType, webRequest);
+		}
 		if (headerName.length() == 0) {
 			headerName = getRequiredParameterName(methodParam);
 		}
@@ -484,6 +490,34 @@ else if (required) {
 		return binder.convertIfNecessary(headerValue, paramType, methodParam);
 	}
 
+	private Map resolveRequestHeaderMap(Class<? extends Map> mapType, NativeWebRequest webRequest) {
+		if (MultiValueMap.class.isAssignableFrom(mapType)) {
+			MultiValueMap<String, String> result;
+			if (HttpHeaders.class.isAssignableFrom(mapType)) {
+				result = new HttpHeaders();
+			} else {
+				result = new LinkedMultiValueMap<String, String>();
+			}
+			for (Iterator<String> iterator = webRequest.getHeaderNames(); iterator.hasNext();) {
+				String headerName = iterator.next();
+				for (String headerValue : webRequest.getHeaderValues(headerName)) {
+					result.add(headerName, headerValue);
+				}
+			}
+			return result;
+		}
+		else {
+			Map<String, String> result = new LinkedHashMap<String, String>();
+			for (Iterator<String> iterator = webRequest.getHeaderNames(); iterator.hasNext();) {
+				String headerName = iterator.next();
+				String headerValue = webRequest.getHeader(headerName);
+				result.put(headerName, headerValue);
+			}
+			return result;
+		}
+	}
+
+
 	/**
 	 * Resolves the given {@link RequestBody @RequestBody} annotation.
 	 */

org.springframework.web/src/main/java/org/springframework/web/context/request/FacesWebRequest.java

@@ -72,6 +72,10 @@ public String[] getHeaderValues(String headerName) {
 		return getExternalContext().getRequestHeaderValuesMap().get(headerName);
 	}
 
+	public Iterator<String> getHeaderNames() {
+		return getExternalContext().getRequestHeaderMap().keySet().iterator();
+	}
+
 	public String getParameter(String paramName) {
 		return getExternalContext().getRequestParameterMap().get(paramName);
 	}

org.springframework.web/src/main/java/org/springframework/web/context/request/ServletWebRequest.java

@@ -102,6 +102,11 @@ public String[] getHeaderValues(String headerName) {
 		return (!ObjectUtils.isEmpty(headerValues) ? headerValues : null);
 	}
 
+	@SuppressWarnings("unchecked")
+	public Iterator<String> getHeaderNames() {
+		return CollectionUtils.toIterator(getRequest().getHeaderNames());
+	}
+
 	public String getParameter(String paramName) {
 		return getRequest().getParameter(paramName);
 	}

org.springframework.web/src/main/java/org/springframework/web/context/request/WebRequest.java

@@ -47,6 +47,13 @@ public interface WebRequest extends RequestAttributes {
 	 */
 	String[] getHeaderValues(String headerName);
 
+	/**
+	 * Return a Iterator over request header names.
+	 * @see javax.servlet.http.HttpServletRequest#getHeaderNames()
+	 * @since 3.0
+	 */
+	Iterator<String> getHeaderNames();
+
 	/**
 	 * Return the request parameter of the given name, or <code>null</code> if none.
 	 * <p>Retrieves the first parameter value in case of a multi-value parameter.