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.http.client;
018
019import java.io.IOException;
020
021import org.springframework.http.HttpMethod;
022import org.springframework.http.HttpOutputMessage;
023import org.springframework.http.HttpRequest;
024
025/**
026 * Represents a client-side HTTP request.
027 * Created via an implementation of the {@link ClientHttpRequestFactory}.
028 *
029 * <p>A {@code ClientHttpRequest} can be {@linkplain #execute() executed},
030 * receiving a {@link ClientHttpResponse} which can be read from.
031 *
032 * @author Arjen Poutsma
033 * @since 3.0
034 * @see ClientHttpRequestFactory#createRequest(java.net.URI, HttpMethod)
035 */
036public interface ClientHttpRequest extends HttpRequest, HttpOutputMessage {
037
038        /**
039         * Execute this request, resulting in a {@link ClientHttpResponse} that can be read.
040         * @return the response result of the execution
041         * @throws IOException in case of I/O errors
042         */
043        ClientHttpResponse execute() throws IOException;
044
045}