Module io.helidon.http

Package io.helidon.http

Interface HttpConfig

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

Http1ClientProtocolConfig, io.helidon.webclient.http1.Http1ClientProtocolConfigBlueprint, Http1Config, io.helidon.webserver.http1.Http1ConfigBlueprint, Http2ClientProtocolConfig, io.helidon.webclient.http2.Http2ClientProtocolConfigBlueprint, Http2Config, io.helidon.webserver.http2.Http2ConfigBlueprint

All Known Implementing Classes:

Http1ClientProtocolConfig.BuilderBase.Http1ClientProtocolConfigImpl, Http1Config.BuilderBase.Http1ConfigImpl, Http2ClientProtocolConfig.BuilderBase.Http2ClientProtocolConfigImpl, Http2Config.BuilderBase.Http2ConfigImpl, HttpConfig.BuilderBase.HttpConfigImpl

public interface HttpConfig
extends Prototype.Api

Common configuration of HTTP protocol, regardless of its version.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static HttpConfig.Builder	builder(HttpConfig instance)	Create a new fluent API builder from an existing instance.
static HttpConfig	create()	Create a new instance with default values.
static HttpConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static HttpConfig	create(Config config)	Create a new instance from configuration.
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 boolean	validateRequestHeaders()	Whether to validate request headers.
default boolean	validateResponseHeaders()	Whether to validate response headers.

Method Details

builder

static HttpConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static HttpConfig.Builder builder(HttpConfig 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 HttpConfig 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 HttpConfig 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 HttpConfig create()

Create a new instance with default values.

Returns:

a new instance

maxBufferedEntitySize

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().

Returns:

maximum size for a buffered entity

validateRequestHeaders

default boolean validateRequestHeaders()

Whether to validate request headers. If set to false, any request header value is accepted, otherwise request headers and known headers are validated by format (content length is always validated as it is part of protocol processing (other headers may be validated if features use them)).

Defaults to true.

Returns:

whether to validate request headers

validateResponseHeaders

default boolean validateResponseHeaders()

Whether to validate response headers. If set to false, any response header value is accepted, otherwise response headers and known headers are validated by format.

Defaults to true. Disabling this setting can allow invalid response header values to be written.

Returns:

whether to validate response headers

log

default HttpLogConfig log()

HTTP Log configuration.

Returns:

log configuration