001/* 002 * Copyright 2002-2016 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.web.method.annotation; 018 019import java.util.Iterator; 020import java.util.LinkedHashMap; 021import java.util.Map; 022 023import org.springframework.core.MethodParameter; 024import org.springframework.http.HttpHeaders; 025import org.springframework.util.LinkedMultiValueMap; 026import org.springframework.util.MultiValueMap; 027import org.springframework.web.bind.annotation.RequestHeader; 028import org.springframework.web.bind.support.WebDataBinderFactory; 029import org.springframework.web.context.request.NativeWebRequest; 030import org.springframework.web.method.support.HandlerMethodArgumentResolver; 031import org.springframework.web.method.support.ModelAndViewContainer; 032 033/** 034 * Resolves {@link Map} method arguments annotated with {@code @RequestHeader}. 035 * For individual header values annotated with {@code @RequestHeader} see 036 * {@link RequestHeaderMethodArgumentResolver} instead. 037 * 038 * <p>The created {@link Map} contains all request header name/value pairs. 039 * The method parameter type may be a {@link MultiValueMap} to receive all 040 * values for a header, not only the first one. 041 * 042 * @author Arjen Poutsma 043 * @author Rossen Stoyanchev 044 * @since 3.1 045 */ 046public class RequestHeaderMapMethodArgumentResolver implements HandlerMethodArgumentResolver { 047 048 @Override 049 public boolean supportsParameter(MethodParameter parameter) { 050 return (parameter.hasParameterAnnotation(RequestHeader.class) && 051 Map.class.isAssignableFrom(parameter.getParameterType())); 052 } 053 054 @Override 055 public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, 056 NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { 057 058 Class<?> paramType = parameter.getParameterType(); 059 if (MultiValueMap.class.isAssignableFrom(paramType)) { 060 MultiValueMap<String, String> result; 061 if (HttpHeaders.class.isAssignableFrom(paramType)) { 062 result = new HttpHeaders(); 063 } 064 else { 065 result = new LinkedMultiValueMap<String, String>(); 066 } 067 for (Iterator<String> iterator = webRequest.getHeaderNames(); iterator.hasNext();) { 068 String headerName = iterator.next(); 069 String[] headerValues = webRequest.getHeaderValues(headerName); 070 if (headerValues != null) { 071 for (String headerValue : headerValues) { 072 result.add(headerName, headerValue); 073 } 074 } 075 } 076 return result; 077 } 078 else { 079 Map<String, String> result = new LinkedHashMap<String, String>(); 080 for (Iterator<String> iterator = webRequest.getHeaderNames(); iterator.hasNext();) { 081 String headerName = iterator.next(); 082 String headerValue = webRequest.getHeader(headerName); 083 if (headerValue != null) { 084 result.put(headerName, headerValue); 085 } 086 } 087 return result; 088 } 089 } 090 091}