io.helidon.webclient.api.WebClient 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) 2022, 2023 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.concurrent.ExecutorService;
import java.util.function.Consumer;

import io.helidon.builder.api.RuntimeType;
import io.helidon.webclient.spi.Protocol;
import io.helidon.webclient.spi.ProtocolConfig;

/**
 * HTTP client.
 */
@RuntimeType.PrototypedBy(WebClientConfig.class)
public interface WebClient extends RuntimeType.Api, HttpClient {

    /**
     * Create a new builder of the HTTP protocol, that can be used with any supported version.
     * Which versions are supported is determined by the classpath, HTTP/1.1 is always supported.
     * To support a specific HTTP version only,
     * you can use {@link WebClientConfig.Builder#addProtocolPreference(java.util.List)}.
     *
     * @return new HTTP client builder
     */
    static WebClientConfig.Builder builder() {
        return WebClientConfig.builder();
    }

    /**
     * Create a new web client with default configuration.
     *
     * @return a new web client
     */
    static WebClient create() {
        return create(WebClientConfig.create());
    }

    /**
     * Create a new webclient with customized configuration.
     *
     * @param config configuration to use
     * @return a new web client
     */
    static WebClient create(WebClientConfig config) {
        return new LoomClient(config);
    }

    /**
     * Create a new webclient, customizing its configuration.
     *
     * @param consumer configuration consumer
     * @return a new web client
     */
    static WebClient create(Consumer consumer) {
        return builder()
                .update(consumer)
                .build();
    }

    /**
     * To switch to a non-HTTP protocol client (or a client of a specific HTTP version).
     * The resulting protocol will use this client as a base, so it will share all configuration that is
     * relevant for the protocol.
     *
     * @param protocol       protocol instance, usually defined as a constant on the protocol interface
     * @param protocolConfig configuration of the protocol to be used (if customization is required)
     * @param             type of the protocol client
     * @param             type of the protocol config
     * @return a new protocol client instance
     */
     T client(Protocol protocol, C protocolConfig);

    /**
     * To switch to a non-HTTP protocol client (or a client of a specific HTTP version) using its config configured
     * when creating the client, or default config if none configured.
     * The resulting protocol will use this client as a base, so it will share all configuration that is
     * relevant for the protocol.
     *
     * @param protocol protocol instance, usually defined as a constant on the protocol interface
     * @param       type of the protocol client
     * @param       type of the protocol config
     * @return a new protocol client instance
     */
     T client(Protocol protocol);

    /**
     * Executor services, uses virtual threads.
     *
     * @return executor service
     */
    ExecutorService executor();

    /**
     * Cookie manager to use by this client.
     *
     * @return cookie manager
     */
    WebClientCookieManager cookieManager();
}