001/*
002 * Copyright 2002-2014 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.servlet.mvc.method.annotation;
018
019import java.util.Map;
020
021import org.springframework.core.MethodParameter;
022import org.springframework.ui.Model;
023import org.springframework.ui.ModelMap;
024import org.springframework.validation.DataBinder;
025import org.springframework.web.bind.support.WebDataBinderFactory;
026import org.springframework.web.context.request.NativeWebRequest;
027import org.springframework.web.method.support.HandlerMethodArgumentResolver;
028import org.springframework.web.method.support.ModelAndViewContainer;
029import org.springframework.web.servlet.mvc.support.RedirectAttributes;
030import org.springframework.web.servlet.mvc.support.RedirectAttributesModelMap;
031
032/**
033 * Resolves method arguments of type {@link RedirectAttributes}.
034 *
035 * <p>This resolver must be listed ahead of
036 * {@link org.springframework.web.method.annotation.ModelMethodProcessor} and
037 * {@link org.springframework.web.method.annotation.MapMethodProcessor},
038 * which support {@link Map} and {@link Model} arguments both of which are
039 * "super" types of {@code RedirectAttributes} and would also attempt to
040 * resolve a {@code RedirectAttributes} argument.
041 *
042 * @author Rossen Stoyanchev
043 * @since 3.1
044 */
045public class RedirectAttributesMethodArgumentResolver implements HandlerMethodArgumentResolver {
046
047        @Override
048        public boolean supportsParameter(MethodParameter parameter) {
049                return RedirectAttributes.class.isAssignableFrom(parameter.getParameterType());
050        }
051
052        @Override
053        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
054                        NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
055
056                ModelMap redirectAttributes;
057                if(binderFactory != null) {
058                        DataBinder dataBinder = binderFactory.createBinder(webRequest, null, null);
059                        redirectAttributes  = new RedirectAttributesModelMap(dataBinder);
060                }
061                else {
062                        redirectAttributes  = new RedirectAttributesModelMap();
063                }
064                mavContainer.setRedirectModel(redirectAttributes);
065                return redirectAttributes;
066        }
067
068}