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.test.web.servlet;
018
019import org.springframework.mock.web.MockHttpServletRequest;
020
021/**
022 * Extended variant of a {@link RequestBuilder} that applies its
023 * {@link org.springframework.test.web.servlet.request.RequestPostProcessor}s
024 * as a separate step from the {@link #buildRequest} method.
025 *
026 * @author Rossen Stoyanchev
027 * @since 4.1
028 */
029public interface SmartRequestBuilder extends RequestBuilder {
030
031        /**
032         * Apply request post processing. Typically that means invoking one or more
033         * {@link org.springframework.test.web.servlet.request.RequestPostProcessor}s.
034         *
035         * @param request the request to initialize
036         * @return the request to use, either the one passed in or a wrapped one
037         */
038        MockHttpServletRequest postProcessRequest(MockHttpServletRequest request);
039
040}