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.http.client;
018
019import java.io.IOException;
020
021import org.springframework.http.HttpOutputMessage;
022import org.springframework.http.HttpRequest;
023import org.springframework.util.concurrent.ListenableFuture;
024
025/**
026 * Represents a client-side asynchronous HTTP request. Created via an
027 * implementation of the {@link AsyncClientHttpRequestFactory}.
028 *
029 * <p>A {@code AsyncHttpRequest} can be {@linkplain #executeAsync() executed},
030 * getting a future {@link ClientHttpResponse} which can be read from.
031 *
032 * @author Arjen Poutsma
033 * @since 4.0
034 * @see AsyncClientHttpRequestFactory#createAsyncRequest
035 * @deprecated as of Spring 5.0, in favor of {@link org.springframework.web.reactive.function.client.ClientRequest}
036 */
037@Deprecated
038public interface AsyncClientHttpRequest extends HttpRequest, HttpOutputMessage {
039
040        /**
041         * Execute this request asynchronously, resulting in a Future handle.
042         * {@link ClientHttpResponse} that can be read.
043         * @return the future response result of the execution
044         * @throws java.io.IOException in case of I/O errors
045         */
046        ListenableFuture<ClientHttpResponse> executeAsync() throws IOException;
047
048}