Interface Http1ClientProtocolConfig

All Superinterfaces:

HttpConfig, NamedService, ProtocolConfig, Prototype.Api

All Known Implementing Classes:

Http1ClientProtocolConfig.BuilderBase.Http1ClientProtocolConfigImpl

public interface Http1ClientProtocolConfig
extends Prototype.Api, HttpConfig

Configuration of an HTTP/1.1 client.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Http1ClientProtocolConfig.Builder	Fluent API builder for Http1ClientProtocolConfig.
static class	Http1ClientProtocolConfig.BuilderBase<BUILDER extends Http1ClientProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1ClientProtocolConfig>	Fluent API builder base for Http1ClientProtocolConfig.

Method Summary

Modifier and Type	Method	Description
static Http1ClientProtocolConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static Http1ClientProtocolConfig.Builder	builder(Http1ClientProtocolConfig instance)	Create a new fluent API builder from an existing instance.
static Http1ClientProtocolConfig	create()	Create a new instance with default values.
static Http1ClientProtocolConfig	create(Config config)	Create a new instance from configuration.
boolean	defaultKeepAlive()	Whether to use keep alive by default.
int	maxHeaderSize()	Deprecated. This option is deprecated, use HttpConfig.maxHeadersSize() instead
int	maxStatusLineLength()	Configure the maximum allowed length of the status line from the response.
String	name()	Name of this protocol configuration.
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Methods inherited from interface HttpConfig

log, maxBufferedEntitySize, maxHeadersSize, validateRequestHeaders, validateResponseHeaders

Modifier and Type	Method	Description
default HttpLogConfig	log()	HTTP Log configuration.
default Size	maxBufferedEntitySize()	Configure the maximum size allowed for an entity that can be explicitly buffered by the application by calling io.helidon.http.media.ReadableEntity.buffer().
default int	maxHeadersSize()	Configure the maximum allowed headers size, which must be greater than 0.
default boolean	validateRequestHeaders()	Whether to validate request headers.
default boolean	validateResponseHeaders()	Whether to validate response headers.

Method Details

builder

static Http1ClientProtocolConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static Http1ClientProtocolConfig.Builder builder(Http1ClientProtocolConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static Http1ClientProtocolConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static Http1ClientProtocolConfig create()

Create a new instance with default values.

Returns:

a new instance

type

default String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

name

String name()

Name of this protocol configuration.

Specified by:

name in interface NamedService

Returns:

protocol configuration name

defaultKeepAlive

boolean defaultKeepAlive()

Whether to use keep alive by default.

Returns:

true for keeping connections alive and re-using them for multiple requests (default), false to create a new connection for each request

maxHeaderSize

@Deprecated(since="27.0.0")
int maxHeaderSize()

Deprecated.

This option is deprecated, use HttpConfig.maxHeadersSize() instead

Configure the maximum allowed headers size of the response, which must be greater than 0.

If both max-header-size and max-headers-size are configured, the deprecated max-header-size key takes precedence for backward compatibility.

Returns:

maximum headers size

maxStatusLineLength

int maxStatusLineLength()

Configure the maximum allowed length of the status line from the response.

Returns:

maximum status line length