com.rabbitmq.http.client.OkHttpClientBuilderConfigurator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client Show documentation

Java client for the RabbitMQ HTTP API

There is a newer version: 5.3.0

/*
 * Copyright 2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.rabbitmq.http.client;

import okhttp3.OkHttpClient;

/**
 * Implementations of this interface can perform post-configuration
 * of {@link OkHttpClient.Builder} used by {@link Client} internally.
 * Note that {@link OkHttpRestTemplateConfigurator} will configure all essential settings
 * before invoking the configurator.
 * 
 * {@link OkHttpClientBuilderConfigurator} implementations typically
 * customize request interceptors to set specific headers, proxy-related
 * and TLS-related settings.
 *
 * @since 3.6.0
 */
@FunctionalInterface
public interface OkHttpClientBuilderConfigurator {

    /**
     * Configure the {@link OkHttpClient.Builder}.
     *
     * @param builder incoming builder
     * @return configured builder, usually same instance as the parameter
     */
    OkHttpClient.Builder configure(OkHttpClient.Builder builder);
}