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