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.web.client;
018
019import java.io.IOException;
020
021/**
022 * Callback interface for code that operates on an
023 * {@link org.springframework.http.client.AsyncClientHttpRequest}. Allows to
024 * manipulate the request headers, and write to the request body.
025 *
026 * <p>Used internally by the {@link AsyncRestTemplate}, but also useful for
027 * application code.
028 *
029 * @author Arjen Poutsma
030 * @see org.springframework.web.client.AsyncRestTemplate#execute
031 * @since 4.0
032 * @deprecated as of Spring 5.0, in favor of
033 * {@link org.springframework.web.reactive.function.client.ExchangeFilterFunction}
034 */
035@FunctionalInterface
036@Deprecated
037public interface AsyncRequestCallback {
038
039        /**
040         * Gets called by {@link AsyncRestTemplate#execute} with an opened {@code ClientHttpRequest}.
041         * Does not need to care about closing the request or about handling errors:
042         * this will all be handled by the {@code RestTemplate}.
043         * @param request the active HTTP request
044         * @throws java.io.IOException in case of I/O errors
045         */
046        void doWithRequest(org.springframework.http.client.AsyncClientHttpRequest request) throws IOException;
047
048}