io.helidon.webclient.http1.Http1ClientProtocolConfigBlueprint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-webclient-http1 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.http1;

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

/**
 * Configuration of an HTTP/1.1 client.
 */
@Prototype.Blueprint
@Prototype.Configured
interface Http1ClientProtocolConfigBlueprint extends ProtocolConfig {
    @Override
    default String type() {
        return Http1ProtocolProvider.CONFIG_KEY;
    }

    @Option.Configured
    @Option.Default(Http1ProtocolProvider.CONFIG_KEY)
    @Override
    String name();

    /**
     * Whether to use keep alive by default.
     *
     * @return {@code true} for keeping connections alive and re-using them for multiple requests (default), {@code false}
     *  to create a new connection for each request
     */
    @Option.Configured
    @Option.DefaultBoolean(true)
    boolean defaultKeepAlive();

    /**
     * Configure the maximum allowed header size of the response.
     *
     * @return  maximum header size
     */
    @Option.Configured
    @Option.DefaultInt(16384)
    int maxHeaderSize();

    /**
     * Configure the maximum allowed length of the status line from the response.
     *
     * @return maximum status line length
     */
    @Option.Configured
    @Option.DefaultInt(256)
    int maxStatusLineLength();

    /**
     * Sets whether the request header format is validated or not.
     * 
     *     Defaults to {@code false} as user has control on the header creation.
     * 
     *
     * @return whether request header validation should be enabled
     */
    @Option.Configured
    @Option.DefaultBoolean(false)
    boolean validateRequestHeaders();

    /**
     * Sets whether the response header format is validated or not.
     * 
     *     Defaults to {@code true}.
     * 
     *
     * @return whether response header validation should be enabled
     */
    @Option.Configured
    @Option.DefaultBoolean(true)
    boolean validateResponseHeaders();
}