Module io.helidon.webserver

Package io.helidon.webserver

Interface SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>>

Type Parameters:

B - type of the subclass of this class to provide correct fluent API

All Known Implementing Classes:

ServerConfiguration.Builder, SocketConfiguration.Builder, WebServer.Builder

Enclosing interface:

SocketConfiguration

public static interface SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>>

Socket configuration builder API, used by SocketConfiguration.Builder to configure additional sockets, and by WebServer.Builder to configure the default socket.

Method Summary

Modifier and Type	Method	Description
B	backlog(int backlog)	Configures a maximum length of the queue of incoming connections on the server socket.
default B	bindAddress(String address)	Configures local address where the server listens on with the server socket.
B	bindAddress(InetAddress bindAddress)	Configures local address where the server listens on with the server socket.
default B	config(Config config)	Update this socket configuration from a Config.
B	enableCompression(boolean value)	Enable negotiation for gzip/deflate content encodings.
default B	host(String address)	A helper method that just calls bindAddress(String).
B	maxHeaderSize(int size)	Maximal number of bytes of all header values combined.
B	maxInitialLineLength(int length)	Maximal number of characters in the initial HTTP line.
B	maxPayloadSize(long size)	Set a maximum payload size for a client request.
B	port(int port)	Configures a server port to listen on with the server socket.
B	receiveBufferSize(int receiveBufferSize)	Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
B	timeout(long amount, TimeUnit unit)	Configures a server socket timeout.
B	tls(WebServerTls webServerTls)	Configures SSL for this socket.
default B	tls(Supplier<WebServerTls> tlsConfig)	Configures SSL for this socket.

Method Detail

port

B port(int port)

Configures a server port to listen on with the server socket. If port is 0 then any available ephemeral port will be used.

Parameters:

port - the server port of the server socket

Returns:

this builder

bindAddress

default B bindAddress(String address)

Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.

Parameters:

address - an address to bind with the server socket

Returns:

this builder

Throws:

NullPointerException - in case the bind address is null

ConfigException - in case the address provided is not a valid host address

host

default B host(String address)

A helper method that just calls bindAddress(String).

Parameters:

address - host to listen on

Returns:

this builder

bindAddress

B bindAddress(InetAddress bindAddress)

Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.

Parameters:

bindAddress - an address to bind with the server socket

Returns:

this builder

Throws:

NullPointerException - in case the bind address is null

backlog

B backlog(int backlog)

Configures a maximum length of the queue of incoming connections on the server socket.

Default value is SocketConfiguration.DEFAULT_BACKLOG_SIZE.

Parameters:

backlog - a maximum length of the queue of incoming connections

Returns:

this builder

timeout

B timeout(long amount,
          TimeUnit unit)

Configures a server socket timeout.

Parameters:

amount - an amount of time to configure the timeout, use 0 for infinite timeout

unit - time unit to use with the configured amount

Returns:

this builder

receiveBufferSize

B receiveBufferSize(int receiveBufferSize)

Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.

If 0 then use implementation default.

Parameters:

receiveBufferSize - a buffer size in bytes of the server socket or 0

Returns:

this builder

tls

B tls(WebServerTls webServerTls)

Configures SSL for this socket. When configured, the server enforces SSL configuration. If this method is called, any other method except for tls(java.util.function.Supplier)¨ and repeated invocation of this method would be ignored.

If this method is called again, the previous configuration would be ignored.

Parameters:

webServerTls - ssl configuration to use with this socket

Returns:

this builder

tls

default B tls(Supplier<WebServerTls> tlsConfig)

Configures SSL for this socket. When configured, the server enforces SSL configuration.

Parameters:

tlsConfig - supplier ssl configuration to use with this socket

Returns:

this builder

maxHeaderSize

B maxHeaderSize(int size)

Maximal number of bytes of all header values combined. When a bigger value is received, a Http.Status.BAD_REQUEST_400 is returned.

Default is 8192

Parameters:

size - maximal number of bytes of combined header values

Returns:

this builder

maxInitialLineLength

B maxInitialLineLength(int length)

Maximal number of characters in the initial HTTP line.

Default is 4096

Parameters:

length - maximal number of characters

Returns:

this builder

enableCompression

B enableCompression(boolean value)

Enable negotiation for gzip/deflate content encodings. Clients can request compression using the "Accept-Encoding" header.

Default is false

Parameters:

value - compression flag

Returns:

this builder

maxPayloadSize

B maxPayloadSize(long size)

Set a maximum payload size for a client request. Can prevent DoS attacks.

Parameters:

size - maximum payload size

Returns:

this builder

config

default B config(Config config)

Update this socket configuration from a Config.

Parameters:

config - configuration on the node of a socket

Returns:

updated builder instance