001/* 002 * Copyright 2002-2009 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 021import org.springframework.http.client.ClientHttpRequest; 022 023/** 024 * Callback interface for code that operates on a {@link ClientHttpRequest}. Allows to manipulate the request 025 * headers, and write to the request body. 026 * 027 * <p>Used internally by the {@link RestTemplate}, but also useful for application code. 028 * 029 * @author Arjen Poutsma 030 * @see RestTemplate#execute 031 * @since 3.0 032 */ 033public interface RequestCallback { 034 035 /** 036 * Gets called by {@link RestTemplate#execute} with an opened {@code ClientHttpRequest}. 037 * Does not need to care about closing the request or about handling errors: 038 * this will all be handled by the {@code RestTemplate}. 039 * @param request the active HTTP request 040 * @throws IOException in case of I/O errors 041 */ 042 void doWithRequest(ClientHttpRequest request) throws IOException; 043 044}