io.helidon.webclient.api.WebClientConfigBlueprint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-webclient-api Show documentation

The newest version!

/*
 * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
 *
 * 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
 *
 *     http://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 io.helidon.webclient.api;

import java.util.List;

import io.helidon.builder.api.Option;
import io.helidon.builder.api.Prototype;
import io.helidon.webclient.spi.ProtocolConfig;
import io.helidon.webclient.spi.ProtocolConfigProvider;

/**
 * WebClient configuration.
 */
@Prototype.Blueprint
@Prototype.Configured("clients")
interface WebClientConfigBlueprint extends HttpClientConfigBlueprint, Prototype.Factory {
    /**
     * Configuration of client protocols.
     *
     * @return client protocol configurations
     */
    @Option.Configured
    @Option.Provider(ProtocolConfigProvider.class)
    @Option.Singular
    List protocolConfigs();

    /**
     * List of HTTP protocol IDs by order of preference. If left empty, all discovered providers will be used, ordered by
     * weight.
     * 
     * For example if both HTTP/2 and HTTP/1.1 providers are available (considering HTTP/2 has higher weights), for ALPN
     * we will send h2 and http/1.1 and decide based on response.
     * If TLS is not used, we would attempt an upgrade (or use prior knowledge if configured in {@link #protocolConfigs()}).
     *
     * @return list of HTTP protocol IDs in order of preference
     */
    @Option.Singular
    List protocolPreference();
}