Package io.helidon.webserver

Class ServerConfiguration.Builder

java.lang.Object

io.helidon.webserver.ServerConfiguration.Builder

All Implemented Interfaces:

Builder<ServerConfiguration>

Enclosing interface:

ServerConfiguration

public static final class ServerConfiguration.Builder
extends java.lang.Object
implements Builder<ServerConfiguration>

A ServerConfiguration builder.

Method Summary

Modifier and Type	Method	Description
ServerConfiguration.Builder	addSocket(java.lang.String name, int port, java.net.InetAddress bindAddress)	Adds an additional named server socket configuration.
ServerConfiguration.Builder	addSocket(java.lang.String name, Builder<SocketConfiguration> socketConfigurationBuilder)	Adds an additional named server socket configuration builder.
ServerConfiguration.Builder	addSocket(java.lang.String name, SocketConfiguration socketConfiguration)	Adds an additional named server socket configuration.
ServerConfiguration.Builder	backlog(int size)	Sets a maximum length of the queue of incoming connections.
ServerConfiguration.Builder	bindAddress(java.net.InetAddress bindAddress)	Sets a local address for server to bind.
ServerConfiguration	build()	Builds a new configuration instance.
ServerConfiguration.Builder	config(Config config)	Sets configuration values included in provided Config parameter.
ServerConfiguration.Builder	experimental(ExperimentalConfiguration experimental)
ServerConfiguration.Builder	port(int port)	Sets server port.
ServerConfiguration.Builder	receiveBufferSize(int bytes)	Propose value of the TCP receive window that is advertised to the remote peer.
ServerConfiguration.Builder	ssl(Builder<? extends javax.net.ssl.SSLContext> sslContextBuilder)	Sets SSLContext to to use with the server.
ServerConfiguration.Builder	ssl(javax.net.ssl.SSLContext sslContext)	Sets SSLContext to to use with the server.
ServerConfiguration.Builder	timeout(int milliseconds)	Sets a socket timeout in milliseconds or 0 for infinite timeout.
ServerConfiguration.Builder	tracer(Builder<? extends io.opentracing.Tracer> tracerBuilder)	Sets an opentracing.io tracer.
ServerConfiguration.Builder	tracer(io.opentracing.Tracer tracer)	Sets an opentracing.io tracer.
ServerConfiguration.Builder	workersCount(int workers)	Sets a count of threads in pool used to tryProcess HTTP requests.

Methods inherited from class java.lang.Object

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

Method Detail

ssl

public ServerConfiguration.Builder ssl(javax.net.ssl.SSLContext sslContext)

Sets SSLContext to to use with the server. If not null then server enforce SSL communication.

Parameters:

sslContext - ssl context

Returns:

an updated builder

ssl

public ServerConfiguration.Builder ssl(Builder<? extends javax.net.ssl.SSLContext> sslContextBuilder)

Sets SSLContext to to use with the server. If not null then server enforce SSL communication.

Parameters:

sslContextBuilder - ssl context builder; will be built as a first step of this method execution

Returns:

an updated builder

port

public ServerConfiguration.Builder port(int port)

Sets server port. If port is 0 or less then any available ephemeral port will be used.

Configuration key: port

Parameters:

port - the server port

Returns:

an updated builder

bindAddress

public ServerConfiguration.Builder bindAddress(java.net.InetAddress bindAddress)

Sets a local address for server to bind. If null then listens an all local addresses.

Configuration key: bind-address

Parameters:

bindAddress - the address to bind the server or null for all local addresses

Returns:

an updated builder

backlog

public ServerConfiguration.Builder backlog(int size)

Sets a maximum length of the queue of incoming connections. Default value is 1024.

Configuration key: backlog

Parameters:

size - the maximum length of the queue of incoming connections

Returns:

an updated builder

timeout

public ServerConfiguration.Builder timeout(int milliseconds)

Sets a socket timeout in milliseconds or 0 for infinite timeout.

Configuration key: timeout

Parameters:

milliseconds - a socket timeout in milliseconds or 0

Returns:

an updated builder

receiveBufferSize

public ServerConfiguration.Builder receiveBufferSize(int bytes)

Propose value of the TCP receive window that is advertised to the remote peer. If 0 then implementation default is used.

Configuration key: receive-buffer

Parameters:

bytes - a buffer size in bytes or 0

Returns:

an updated builder

addSocket

public ServerConfiguration.Builder addSocket(java.lang.String name,
                                             int port,
                                             java.net.InetAddress bindAddress)

Adds an additional named server socket configuration. As a result, the server will listen on multiple ports.

An additional named server socket may have a dedicated Routing configured through WebServer.Builder.addNamedRouting(String, Routing).

Parameters:

name - the name of the additional server socket configuration

port - the port to bind; if 0 or less, any available ephemeral port will be used

bindAddress - the address to bind; if null, all local addresses will be bound

Returns:

an updated builder

addSocket

public ServerConfiguration.Builder addSocket(java.lang.String name,
                                             SocketConfiguration socketConfiguration)

Adds an additional named server socket configuration. As a result, the server will listen on multiple ports.

An additional named server socket may have a dedicated Routing configured through WebServer.Builder.addNamedRouting(String, Routing).

Parameters:

name - the name of the additional server socket configuration

socketConfiguration - the additional named server socket configuration

Returns:

an updated builder

addSocket

public ServerConfiguration.Builder addSocket(java.lang.String name,
                                             Builder<SocketConfiguration> socketConfigurationBuilder)

Adds an additional named server socket configuration builder. As a result, the server will listen on multiple ports.

An additional named server socket may have a dedicated Routing configured through WebServer.Builder.addNamedRouting(String, Routing).

Parameters:

name - the name of the additional server socket configuration

socketConfigurationBuilder - the additional named server socket configuration builder; will be built as a first step of this method execution

Returns:

an updated builder

workersCount

public ServerConfiguration.Builder workersCount(int workers)

Sets a count of threads in pool used to tryProcess HTTP requests. Default value is CPU_COUNT * 2.

Configuration key: workers

Parameters:

workers - a workers count

Returns:

an updated builder

tracer

public ServerConfiguration.Builder tracer(io.opentracing.Tracer tracer)

Sets an opentracing.io tracer. (Default is GlobalTracer.)

Parameters:

tracer - a tracer to set

Returns:

an updated builder

tracer

public ServerConfiguration.Builder tracer(Builder<? extends io.opentracing.Tracer> tracerBuilder)

Sets an opentracing.io tracer. (Default is GlobalTracer.)

Parameters:

tracerBuilder - a tracer builder to set; will be built as a first step of this method execution

Returns:

updated builder

experimental

public ServerConfiguration.Builder experimental(ExperimentalConfiguration experimental)

config

public ServerConfiguration.Builder config(Config config)

Sets configuration values included in provided Config parameter.

It can be used for configuration externalisation.

All parameters sets before this method call can be seen as defaults and all parameters sets after can be seen as forced.

Parameters:

config - the configuration to use

Returns:

an updated builder

build

public ServerConfiguration build()

Builds a new configuration instance.

Specified by:

build in interface Builder<ServerConfiguration>

Returns:

a new instance