Class Http1Config.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

java.lang.Object

io.helidon.http.HttpConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.webserver.http1.Http1Config.BuilderBase<BUILDER, PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Direct Known Subclasses:

Http1Config.Builder

Enclosing interface:

Http1Config

public abstract static class Http1Config.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>
extends HttpConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for Http1Config.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Http1Config.BuilderBase.Http1ConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class HttpConfig.BuilderBase

HttpConfig.BuilderBase.HttpConfigImpl

Modifier and Type	Class	Description
protected static class	HttpConfig.BuilderBase.HttpConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addReceiveListener(Http1ConnectionListener receiveListener)	Connection receive event listeners for HTTP/1.1.
BUILDER	addReceiveListeners(List<? extends Http1ConnectionListener> receiveListeners)	Connection receive event listeners for HTTP/1.1.
BUILDER	addSendListener(Http1ConnectionListener sendListener)	Connection send event listeners for HTTP/1.1.
BUILDER	addSendListeners(List<? extends Http1ConnectionListener> sendListeners)	Connection send event listeners for HTTP/1.1.
Optional<AltSvc>	altSvc()	Explicit Alt-Svc advertisement.
BUILDER	altSvc(AltSvc altSvc)	Explicit Alt-Svc advertisement.
BUILDER	altSvc(AltSvcConfig altSvc)	Explicit Alt-Svc advertisement.
BUILDER	altSvc(Consumer<AltSvcConfig.Builder> consumer)	Explicit Alt-Svc advertisement.
BUILDER	clearAltSvc()	Clear existing value of altSvc.
BUILDER	clearReceiveListeners()	Clear all receiveListeners.
BUILDER	clearSendListeners()	Clear all sendListeners.
Optional<Http1ConnectionListener>	compositeReceiveListener()	A single receive listener, this value is computed.
BUILDER	compositeReceiveListener(Http1ConnectionListener compositeReceiveListener)	A single receive listener, this value is computed.
Optional<Http1ConnectionListener>	compositeSendListener()	A single send listener, this value is computed.
BUILDER	compositeSendListener(Http1ConnectionListener compositeSendListener)	A single send listener, this value is computed.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
boolean	continueImmediately()	When true WebServer answers to expect continue with 100 continue immediately, not waiting for user to actually request the data.
BUILDER	continueImmediately(boolean continueImmediately)	When true WebServer answers to expect continue with 100 continue immediately, not waiting for user to actually request the data.
BUILDER	from(Http1Config prototype)	Update this builder from an existing prototype instance.
BUILDER	from(Http1Config.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
int	maxHeadersSize()	Maximum size of received headers in bytes, which must be greater than 0.
BUILDER	maxHeadersSize(int maxHeadersSize)	Maximum size of received headers in bytes, which must be greater than 0.
int	maxPrologueLength()	Maximal size of received HTTP prologue (GET /path HTTP/1.1).
BUILDER	maxPrologueLength(int maxPrologueLength)	Maximal size of received HTTP prologue (GET /path HTTP/1.1).
Optional<String>	name()	Name of this configuration, in most cases the same as Http1Config.type().
BUILDER	name(String name)	Name of this configuration, in most cases the same as Http1Config.type().
protected void	preBuildPrototype()	Handles providers and decorators.
List<Http1ConnectionListener>	receiveListeners()	Connection receive event listeners for HTTP/1.1.
BUILDER	receiveListeners(List<? extends Http1ConnectionListener> receiveListeners)	Connection receive event listeners for HTTP/1.1.
boolean	receiveLog()	Deprecated, for removal: This API element is subject to removal in a future version. use HttpConfig.BuilderBase.log()
BUILDER	receiveLog(boolean receiveLog)	Deprecated, for removal: This API element is subject to removal in a future version. use HttpConfig.BuilderBase.log()
Optional<RequestedUriDiscoveryContext>	requestedUriDiscovery()	Requested URI discovery settings.
BUILDER	requestedUriDiscovery(RequestedUriDiscoveryContext requestedUriDiscovery)	Requested URI discovery settings.
BUILDER	requestedUriDiscovery(Consumer<RequestedUriDiscoveryContext.Builder> consumer)	Requested URI discovery settings.
BUILDER	requestedUriDiscovery(Supplier<? extends RequestedUriDiscoveryContext> supplier)	Requested URI discovery settings.
List<Http1ConnectionListener>	sendListeners()	Connection send event listeners for HTTP/1.1.
BUILDER	sendListeners(List<? extends Http1ConnectionListener> sendListeners)	Connection send event listeners for HTTP/1.1.
boolean	sendLog()	Deprecated, for removal: This API element is subject to removal in a future version. use HttpConfig.BuilderBase.log()
BUILDER	sendLog(boolean sendLog)	Deprecated, for removal: This API element is subject to removal in a future version. use HttpConfig.BuilderBase.log()
String	toString()
boolean	validatePath()	Whether to validate path characters and HTTP/1.1 request-target forms.
BUILDER	validatePath(boolean validatePath)	Whether to validate path characters and HTTP/1.1 request-target forms.
boolean	validatePrologue()	Disables query and fragment syntax validation when set to false; intended only for closed systems receiving trusted, valid request targets, as behavior for invalid input is unspecified.
BUILDER	validatePrologue(boolean validatePrologue)	Disables query and fragment syntax validation when set to false; intended only for closed systems receiving trusted, valid request targets, as behavior for invalid input is unspecified.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class HttpConfig.BuilderBase

config, from, from, log, log, log, log, maxBufferedEntitySize, maxBufferedEntitySize, validateRequestHeaders, validateRequestHeaders, validateResponseHeaders, validateResponseHeaders

Modifier and Type	Method	Description
protected Optional<Config>	config()	Configuration used to configure this instance.
BUILDER	from(HttpConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(HttpConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
HttpLogConfig	log()	HTTP Log configuration.
BUILDER	log(HttpLogConfig log)	HTTP Log configuration.
BUILDER	log(Consumer<HttpLogConfig.Builder> consumer)	HTTP Log configuration.
BUILDER	log(Supplier<? extends HttpLogConfig> supplier)	HTTP Log configuration.
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().
BUILDER	maxBufferedEntitySize(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().
boolean	validateRequestHeaders()	Whether to validate request headers.
BUILDER	validateRequestHeaders(boolean validateRequestHeaders)	Whether to validate request headers.
boolean	validateResponseHeaders()	Whether to validate response headers.
BUILDER	validateResponseHeaders(boolean validateResponseHeaders)	Whether to validate response headers.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(Http1Config prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(Http1Config.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

Overrides:

config in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

name

public BUILDER name(String name)

Name of this configuration, in most cases the same as Http1Config.type().

Parameters:

name - name of this configuration

Returns:

updated builder instance

See Also:

• name()

maxPrologueLength

public BUILDER maxPrologueLength(int maxPrologueLength)

Maximal size of received HTTP prologue (GET /path HTTP/1.1).

Parameters:

maxPrologueLength - maximal size in bytes

Returns:

updated builder instance

See Also:

• maxPrologueLength()

maxHeadersSize

public BUILDER maxHeadersSize(int maxHeadersSize)

Maximum size of received headers in bytes, which must be greater than 0. Defaults to 16384.

This override preserves generated Http1Config.BuilderBase binary compatibility.

Overrides:

maxHeadersSize in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

Parameters:

maxHeadersSize - maximum headers size

Returns:

updated builder instance

See Also:

• maxHeadersSize()

validatePrologue

public BUILDER validatePrologue(boolean validatePrologue)

Disables query and fragment syntax validation when set to false; intended only for closed systems receiving trusted, valid request targets, as behavior for invalid input is unspecified. Validation of path is controlled by validatePath().

Parameters:

validatePrologue - whether to validate prologue query and fragment

Returns:

updated builder instance

See Also:

• validatePrologue()

validatePath

public BUILDER validatePath(boolean validatePath)

Whether to validate path characters and HTTP/1.1 request-target forms.

Parameters:

validatePath - whether to validate path

Returns:

updated builder instance

See Also:

• validatePath()

continueImmediately

public BUILDER continueImmediately(boolean continueImmediately)

When true WebServer answers to expect continue with 100 continue immediately, not waiting for user to actually request the data.

Parameters:

continueImmediately - if true answer with 100 continue immediately after expect continue

Returns:

updated builder instance

See Also:

• continueImmediately()

requestedUriDiscovery

public BUILDER requestedUriDiscovery(RequestedUriDiscoveryContext requestedUriDiscovery)

Requested URI discovery settings.

Parameters:

requestedUriDiscovery - settings for computing the requested URI

Returns:

updated builder instance

See Also:

• requestedUriDiscovery()

requestedUriDiscovery

public BUILDER requestedUriDiscovery(Consumer<RequestedUriDiscoveryContext.Builder> consumer)

Requested URI discovery settings.

Parameters:

consumer - consumer of builder of settings for computing the requested URI

Returns:

updated builder instance

See Also:

• requestedUriDiscovery()

requestedUriDiscovery

public BUILDER requestedUriDiscovery(Supplier<? extends RequestedUriDiscoveryContext> supplier)

Requested URI discovery settings.

Parameters:

supplier - supplier of settings for computing the requested URI

Returns:

updated builder instance

See Also:

• requestedUriDiscovery()

clearSendListeners

public BUILDER clearSendListeners()

Clear all sendListeners.

Returns:

updated builder instance

See Also:

• sendListeners()

sendListeners

public BUILDER sendListeners(List<? extends Http1ConnectionListener> sendListeners)

Connection send event listeners for HTTP/1.1.

Parameters:

sendListeners - send event listeners

Returns:

updated builder instance

See Also:

• sendListeners()

addSendListeners

public BUILDER addSendListeners(List<? extends Http1ConnectionListener> sendListeners)

Connection send event listeners for HTTP/1.1.

Parameters:

sendListeners - send event listeners

Returns:

updated builder instance

See Also:

• sendListeners()

addSendListener

public BUILDER addSendListener(Http1ConnectionListener sendListener)

Connection send event listeners for HTTP/1.1.

Parameters:

sendListener - add single send event listeners

Returns:

updated builder instance

See Also:

• sendListeners()

clearReceiveListeners

public BUILDER clearReceiveListeners()

Clear all receiveListeners.

Returns:

updated builder instance

See Also:

• receiveListeners()

receiveListeners

public BUILDER receiveListeners(List<? extends Http1ConnectionListener> receiveListeners)

Connection receive event listeners for HTTP/1.1.

Parameters:

receiveListeners - receive event listeners

Returns:

updated builder instance

See Also:

• receiveListeners()

addReceiveListeners

public BUILDER addReceiveListeners(List<? extends Http1ConnectionListener> receiveListeners)

Connection receive event listeners for HTTP/1.1.

Parameters:

receiveListeners - receive event listeners

Returns:

updated builder instance

See Also:

• receiveListeners()

addReceiveListener

public BUILDER addReceiveListener(Http1ConnectionListener receiveListener)

Connection receive event listeners for HTTP/1.1.

Parameters:

receiveListener - add single receive event listeners

Returns:

updated builder instance

See Also:

• receiveListeners()

clearAltSvc

public BUILDER clearAltSvc()

Clear existing value of altSvc.

Returns:

updated builder instance

See Also:

• altSvc()

altSvc

public BUILDER altSvc(AltSvc altSvc)

Explicit Alt-Svc advertisement.

Parameters:

altSvc - alternative service advertisement

Returns:

updated builder instance

See Also:

• altSvc()

altSvc

public BUILDER altSvc(AltSvcConfig altSvc)

Explicit Alt-Svc advertisement.

Parameters:

altSvc - prototype of alternative service advertisement

Returns:

updated builder instance

See Also:

• altSvc()

altSvc

public BUILDER altSvc(Consumer<AltSvcConfig.Builder> consumer)

Explicit Alt-Svc advertisement.

Parameters:

consumer - consumer of builder of alternative service advertisement

Returns:

updated builder instance

See Also:

• altSvc()

compositeSendListener

public BUILDER compositeSendListener(Http1ConnectionListener compositeSendListener)

A single send listener, this value is computed.

Parameters:

compositeSendListener - send listener

Returns:

updated builder instance

See Also:

• compositeSendListener()

compositeReceiveListener

public BUILDER compositeReceiveListener(Http1ConnectionListener compositeReceiveListener)

A single receive listener, this value is computed.

Parameters:

compositeReceiveListener - receive listener

Returns:

updated builder instance

See Also:

• compositeReceiveListener()

receiveLog

@Deprecated(since="4.5.0",
            forRemoval=true)
public BUILDER receiveLog(boolean receiveLog)

Deprecated, for removal: This API element is subject to removal in a future version.

use HttpConfig.BuilderBase.log()

Logging of received packets. Uses trace and debug levels on logger of Http1LoggingConnectionListener with suffix of .recv`.

Parameters:

receiveLog - true if logging should be enabled for received packets, false if no logging should be done

Returns:

updated builder instance

See Also:

• receiveLog()

sendLog

@Deprecated(since="4.5.0",
            forRemoval=true)
public BUILDER sendLog(boolean sendLog)

Deprecated, for removal: This API element is subject to removal in a future version.

use HttpConfig.BuilderBase.log()

Logging of sent packets. Uses trace and debug levels on logger of Http1LoggingConnectionListener with suffix of .send`.

Parameters:

sendLog - true if logging should be enabled for sent packets, false if no logging should be done

Returns:

updated builder instance

See Also:

• sendLog()

name

public Optional<String> name()

Name of this configuration, in most cases the same as Http1Config.type().

Returns:

name of this configuration

maxPrologueLength

public int maxPrologueLength()

Maximal size of received HTTP prologue (GET /path HTTP/1.1).

Returns:

maximal size in bytes

maxHeadersSize

public int maxHeadersSize()

Maximum size of received headers in bytes, which must be greater than 0. Defaults to 16384.

This override preserves generated Http1Config.BuilderBase binary compatibility.

Overrides:

maxHeadersSize in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

Returns:

maximum headers size

validatePrologue

public boolean validatePrologue()

Disables query and fragment syntax validation when set to false; intended only for closed systems receiving trusted, valid request targets, as behavior for invalid input is unspecified. Validation of path is controlled by validatePath().

Returns:

whether to validate prologue query and fragment

validatePath

public boolean validatePath()

Whether to validate path characters and HTTP/1.1 request-target forms.

Returns:

whether to validate path

continueImmediately

public boolean continueImmediately()

When true WebServer answers to expect continue with 100 continue immediately, not waiting for user to actually request the data.

Returns:

if true answer with 100 continue immediately after expect continue

requestedUriDiscovery

public Optional<RequestedUriDiscoveryContext> requestedUriDiscovery()

Requested URI discovery settings.

Returns:

settings for computing the requested URI

sendListeners

public List<Http1ConnectionListener> sendListeners()

Connection send event listeners for HTTP/1.1.

Returns:

send event listeners

receiveListeners

public List<Http1ConnectionListener> receiveListeners()

Connection receive event listeners for HTTP/1.1.

Returns:

receive event listeners

altSvc

public Optional<AltSvc> altSvc()

Explicit Alt-Svc advertisement.

Returns:

alternative service advertisement

compositeSendListener

public Optional<Http1ConnectionListener> compositeSendListener()

A single send listener, this value is computed.

Returns:

send listener

compositeReceiveListener

public Optional<Http1ConnectionListener> compositeReceiveListener()

A single receive listener, this value is computed.

Returns:

receive listener

receiveLog

@Deprecated(since="4.5.0",
            forRemoval=true)
public boolean receiveLog()

Deprecated, for removal: This API element is subject to removal in a future version.

use HttpConfig.BuilderBase.log()

Logging of received packets. Uses trace and debug levels on logger of Http1LoggingConnectionListener with suffix of .recv`.

Returns:

true if logging should be enabled for received packets, false if no logging should be done

sendLog

@Deprecated(since="4.5.0",
            forRemoval=true)
public boolean sendLog()

Deprecated, for removal: This API element is subject to removal in a future version.

use HttpConfig.BuilderBase.log()

Logging of sent packets. Uses trace and debug levels on logger of Http1LoggingConnectionListener with suffix of .send`.

Returns:

true if logging should be enabled for sent packets, false if no logging should be done

toString

public String toString()

Overrides:

toString in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class HttpConfig.BuilderBase<BUILDER extends Http1Config.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Http1Config>