Package io.helidon.webserver

Class WebServer.Builder

java.lang.Object

io.helidon.webserver.WebServer.Builder

All Implemented Interfaces:

Builder<WebServer>, Supplier<WebServer>

Enclosing interface:

WebServer

public static final class WebServer.Builder
extends Object
implements Builder<WebServer>

WebServer builder class provides a convenient way to set up WebServer with multiple server sockets and optional multiple routings.

Method Summary

Modifier and Type	Method	Description
WebServer.Builder	addNamedRouting(String name, Routing routing)	Associates a dedicated routing with an additional server socket configuration.
WebServer.Builder	addNamedRouting(String name, Supplier<Routing> routingBuilder)	Associates a dedicated routing with an additional server socket configuration.
WebServer	build()	Builds the WebServer instance as configured by this builder and its parameters.
WebServer.Builder	config(ServerConfiguration configuration)	Set a configuration of the WebServer.
WebServer.Builder	config(Supplier<ServerConfiguration> configurationBuilder)	Set a configuration of the WebServer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

config

public WebServer.Builder config(ServerConfiguration configuration)

Set a configuration of the WebServer.

Parameters:

configuration - the configuration

Returns:

an updated builder

config

public WebServer.Builder config(Supplier<ServerConfiguration> configurationBuilder)

Set a configuration of the WebServer.

Parameters:

configurationBuilder - the configuration builder

Returns:

an updated builder

addNamedRouting

public WebServer.Builder addNamedRouting(String name,
                                         Routing routing)

Associates a dedicated routing with an additional server socket configuration.

The additional server socket configuration must be set as per ServerConfiguration.Builder.addSocket(String, SocketConfiguration). If there is no such named server socket configuration, a IllegalStateException is thrown by the build() method.

Parameters:

name - the named server socket configuration to associate the provided routing with

routing - the routing to associate with the provided name of a named server socket configuration

Returns:

an updated builder

addNamedRouting

public WebServer.Builder addNamedRouting(String name,
                                         Supplier<Routing> routingBuilder)

Associates a dedicated routing with an additional server socket configuration.

The additional server socket configuration must be set as per ServerConfiguration.Builder.addSocket(String, SocketConfiguration). If there is no such named server socket configuration, a IllegalStateException is thrown by the build() method.

Parameters:

name - the named server socket configuration to associate the provided routing with

routingBuilder - the routing builder to associate with the provided name of a named server socket configuration; will be built as a first step of this method execution

Returns:

an updated builder

build

public WebServer build()

Builds the WebServer instance as configured by this builder and its parameters.

Specified by:

build in interface Builder<WebServer>

Returns:

a ready to use WebServer

Throws:

IllegalStateException - if there are unpaired named routings (as described at addNamedRouting(String, Routing))