001/*
002 * Copyright 2002-2019 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 org.springframework.http.client.support.HttpAccessor;
020
021/**
022 * Callback interface for initializing a {@link ClientHttpRequest} prior to it
023 * being used.
024 *
025 * <p>Typically used with {@link HttpAccessor} and subclasses such as
026 * {@link org.springframework.web.client.RestTemplate RestTemplate} to apply
027 * consistent settings or headers to each request.
028 *
029 * <p>Unlike {@link ClientHttpRequestInterceptor}, this interface can apply
030 * customizations without needing to read the entire request body into memory.
031 *
032 * @author Phillip Webb
033 * @since 5.2
034 * @see HttpAccessor#getClientHttpRequestInitializers()
035 */
036@FunctionalInterface
037public interface ClientHttpRequestInitializer {
038
039        /**
040         * Initialize the given client HTTP request.
041         * @param request the request to configure
042         */
043        void initialize(ClientHttpRequest request);
044
045}