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.test.web.servlet;
018
019import javax.servlet.ServletContext;
020
021import org.springframework.mock.web.MockHttpServletRequest;
022
023/**
024 * Builds a {@link MockHttpServletRequest}.
025 *
026 * <p>See static factory methods in
027 * {@link org.springframework.test.web.servlet.request.MockMvcRequestBuilders MockMvcRequestBuilders}.
028 *
029 * @author Arjen Poutsma
030 * @author Rossen Stoyanchev
031 * @since 3.2
032 */
033public interface RequestBuilder {
034
035        /**
036         * Build the request.
037         * @param servletContext the {@link ServletContext} to use to create the request
038         * @return the request
039         */
040        MockHttpServletRequest buildRequest(ServletContext servletContext);
041
042}