Module io.helidon.webclient.http1

Package io.helidon.webclient.http1

Interface Http1ClientProtocolConfig

All Superinterfaces:

NamedService, NamedService, ProtocolConfig, Prototype.Api

All Known Implementing Classes:

Http1ClientProtocolConfig.BuilderBase.Http1ClientProtocolConfigImpl

public interface Http1ClientProtocolConfig
extends Prototype.Api

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)	Deprecated. use create(io.helidon.config.Config)
static Http1ClientProtocolConfig	create(Config config)	Create a new instance from configuration.
boolean	defaultKeepAlive()	Whether to use keep alive by default.
Size	maxBufferedEntitySize()	Configure the maximum size allowed for an entity that can be explicitly buffered by the application by calling ReadableEntity.buffer().
int	maxHeaderSize()	Configure the maximum allowed header size of the response.
int	maxStatusLineLength()	Configure the maximum allowed length of the status line from the response.
String	name()	Name option.
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
boolean	validateRequestHeaders()	Sets whether the request header format is validated or not.
boolean	validateResponseHeaders()	Sets whether the response header format is validated or not.

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

@Deprecated
static Http1ClientProtocolConfig create(Config config)

Deprecated.

use create(io.helidon.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

Specified by:

type in interface NamedService

Returns:

type of this service

name

String name()

Name option.

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

the name option

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

int maxHeaderSize()

Configure the maximum allowed header size of the response.

Returns:

maximum header size

maxStatusLineLength

int maxStatusLineLength()

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

Returns:

maximum status line length

maxBufferedEntitySize

Size maxBufferedEntitySize()

Configure the maximum size allowed for an entity that can be explicitly buffered by the application by calling ReadableEntity.buffer().

Returns:

maximum size for a buffered entity

validateRequestHeaders

boolean validateRequestHeaders()

Sets whether the request header format is validated or not.

Defaults to false as user has control on the header creation.

Returns:

whether request header validation should be enabled

validateResponseHeaders

boolean validateResponseHeaders()

Sets whether the response header format is validated or not.

Defaults to true.

Returns:

whether response header validation should be enabled