001/*
002 * Copyright 2002-2016 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.client;
018
019import java.io.IOException;
020
021import org.springframework.http.client.ClientHttpRequest;
022import org.springframework.http.client.ClientHttpResponse;
023import org.springframework.lang.Nullable;
024import org.springframework.test.web.client.response.MockRestResponseCreators;
025
026/**
027 * A contract for creating a {@link ClientHttpResponse}.
028 * Implementations can be obtained via {@link MockRestResponseCreators}.
029 *
030 * @author Craig Walls
031 * @since 3.2
032 */
033@FunctionalInterface
034public interface ResponseCreator {
035
036        /**
037         * Create a response for the given request.
038         * @param request the request
039         */
040        ClientHttpResponse createResponse(@Nullable ClientHttpRequest request) throws IOException;
041
042}