001/*
002 * Copyright 2002-2017 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 javax.servlet.http.HttpServletRequest;
020
021import org.springframework.core.MethodParameter;
022import org.springframework.web.bind.support.WebDataBinderFactory;
023import org.springframework.web.context.request.NativeWebRequest;
024import org.springframework.web.method.support.HandlerMethodArgumentResolver;
025import org.springframework.web.method.support.ModelAndViewContainer;
026import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
027import org.springframework.web.util.UriComponentsBuilder;
028
029
030/**
031 * Resolvers argument values of type {@link UriComponentsBuilder}.
032 *
033 * <p>The returned instance is initialized via
034 * {@link ServletUriComponentsBuilder#fromServletMapping(HttpServletRequest)}.
035 *
036 * @author Rossen Stoyanchev
037 * @since 3.1
038 */
039public class UriComponentsBuilderMethodArgumentResolver implements HandlerMethodArgumentResolver {
040
041        @Override
042        public boolean supportsParameter(MethodParameter parameter) {
043                Class<?> type = parameter.getParameterType();
044                return (UriComponentsBuilder.class == type || ServletUriComponentsBuilder.class == type);
045        }
046
047        @Override
048        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
049                        NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
050
051                HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
052                return ServletUriComponentsBuilder.fromServletMapping(request);
053        }
054
055}