root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

SPR-6301 - Support @RequestHeader on HttpHeaders parameters

This commit is contained in:
Arjen Poutsma 2009-11-05 15:42:24 +00:00
parent a62b413be4
commit 8de34c6fa7
7 changed files with 131 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
org.springframework.web.portlet/src/main/java/org/springframework/web/portlet/context/PortletWebRequest.java
View File

@ -96,6 +96,10 @@ public class PortletWebRequest extends PortletRequestAttributes implements Nativ
return (!ObjectUtils.isEmpty(headerValues) ? headerValues : null);
}
public Iterator<String> getHeaderNames() {
return CollectionUtils.toIterator(getRequest().getPropertyNames());
}
public String getParameter(String paramName) {
return getRequest().getParameter(paramName);
}

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

@ -66,6 +66,7 @@ import org.springframework.http.HttpInputMessage;
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 class ServletAnnotationControllerTests {
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 class ServletAnnotationControllerTests {
}
}
}
@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);
}
}
}

12
org.springframework.web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java
View File

@ -77,12 +77,16 @@ import java.lang.annotation.Target;
* <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

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

@ -27,6 +27,7 @@ import java.util.List;
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.ParameterNameDiscoverer;
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 @@ public class HandlerMethodInvoker {
}
}
@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 @@ public class HandlerMethodInvoker {
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.
*/

4
org.springframework.web/src/main/java/org/springframework/web/context/request/FacesWebRequest.java
View File

@ -72,6 +72,10 @@ public class FacesWebRequest extends FacesRequestAttributes implements NativeWeb
return getExternalContext().getRequestHeaderValuesMap().get(headerName);
}
public Iterator<String> getHeaderNames() {
return getExternalContext().getRequestHeaderMap().keySet().iterator();
}
public String getParameter(String paramName) {
return getExternalContext().getRequestParameterMap().get(paramName);
}

5
org.springframework.web/src/main/java/org/springframework/web/context/request/ServletWebRequest.java
View File

@ -102,6 +102,11 @@ public class ServletWebRequest extends ServletRequestAttributes implements Nativ
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);
}

7
org.springframework.web/src/main/java/org/springframework/web/context/request/WebRequest.java
View File

@ -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.