```
public interface WebServer
```
Represents a immutably configured WEB server.
Provides basic lifecycle and monitoring API.
Instance can be created from Routing and optionally from Config using create(Routing), create(Routing, io.helidon.config.Config) or builder(Routing)methods and their builder enabled overloads.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`WebServer.Builder`	WebServer builder class provides a convenient way to set up WebServer with multiple server sockets and optional multiple routings.

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_SOCKET_NAME
The default server socket configuration name.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`static WebServer.Builder`	`builder()`	Creates a fluent API builder of the `WebServer`.
`static WebServer.Builder`	`builder(Routing routing)`	Creates a builder of the `WebServer`.
`static WebServer.Builder`	`builder(Supplier<? extends Routing> routingBuilder)`	Creates a builder of the `WebServer`.
`ServerConfiguration`	`configuration()`	Gets effective server configuration.
`Context`	`context()`	Gets a `WebServer` context.
`static WebServer`	`create(Routing routing)`	Creates new instance from provided routing and default configuration.
`static WebServer`	`create(Routing routing, Config config)`	Creates new instance from provided configuration and routing.
`static WebServer`	`create(ServerConfiguration configuration, Routing routing)`	Deprecated. since 2.0.0 - please use `create(Routing, io.helidon.config.Config)` instead for instances based on `Config`, or `builder(Routing)` to configure server configuration by hand (as you would on `SocketConfiguration.Builder` now.
`static WebServer`	`create(ServerConfiguration configuration, Supplier<? extends Routing> routingBuilder)`	Deprecated. since 2.0.0 - please use `create(java.util.function.Supplier, io.helidon.config.Config)` instead for instances based on `Config`, or `builder(java.util.function.Supplier)` to configure server configuration by hand (as you would on `SocketConfiguration.Builder` now.
`static WebServer`	`create(Supplier<? extends Routing> routingBuilder)`	Creates new instance from provided routing and default configuration.
`static WebServer`	`create(Supplier<? extends ServerConfiguration> configurationBuilder, Routing routing)`	Deprecated. since 2.0.0 - please use `create(io.helidon.webserver.Routing, io.helidon.config.Config)` instead for instances based on `Config`, or `builder(io.helidon.webserver.Routing)` to configure server configuration by hand (as you would on `SocketConfiguration.Builder` now.
`static WebServer`	`create(Supplier<? extends ServerConfiguration> configurationBuilder, Supplier<? extends Routing> routingBuilder)`	Deprecated. since 2.0.0 - please use `create(java.util.function.Supplier, io.helidon.config.Config)` instead for instances based on `Config`, or `builder(java.util.function.Supplier)` to configure server configuration by hand (as you would on `SocketConfiguration.Builder` now.
`static WebServer`	`create(Supplier<Routing> routingBuilder, Config config)`	Creates new instance from provided configuration and routing.
`default boolean`	`hasTls()`	Returns `true` if TLS is configured for the default socket.
`boolean`	`hasTls(String socketName)`	Returns `true` if TLS is configured for the named socket.
`boolean`	`isRunning()`	Returns `true` if the server is currently running.
`default int`	`port()`	Returns a port number the default server socket is bound to and is listening on; or `-1` if unknown or not active.
`int`	`port(String socketName)`	Returns a port number an additional named server socket is bound to and is listening on; or `-1` if unknown or not active.
`MessageBodyReaderContext`	`readerContext()`	Get the parent `MessageBodyReaderContext` context.
`Single<WebServer>`	`shutdown()`	Attempt to gracefully shutdown server.
`Single<WebServer>`	`start()`	Starts the server.
`void`	`updateTls(WebServerTls tls)`	Update the TLS configuration of the default socket `DEFAULT_SOCKET_NAME`.
`void`	`updateTls(WebServerTls tls, String socketName)`	Update the TLS configuration of the named socket.
`Single<WebServer>`	`whenShutdown()`	Completion stage is completed when server is shut down.
`MessageBodyWriterContext`	`writerContext()`	Get the parent `MessageBodyWriterContext` context.

- Field Detail
  - DEFAULT_SOCKET_NAME
```
static final String DEFAULT_SOCKET_NAME
```
    The default server socket configuration name. All the default server socket configuration such as WebServer.Builder.hasSocket(String) or port(String) is accessible using this name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - configuration
```
ServerConfiguration configuration()
```
    Gets effective server configuration.
    
    Returns:
    
    Server configuration
  - start
```
Single<WebServer> start()
```
    Starts the server. Has no effect if server is running. The start will fail on a server that is shut down, or that failed to start. In such cases, create a new instance of Web Server.
    
    Returns:
    
    a single to react on startup process
  - whenShutdown
```
Single<WebServer> whenShutdown()
```
    Completion stage is completed when server is shut down.
    
    Returns:
    
    a completion stage of the server
  - shutdown
```
Single<WebServer> shutdown()
```
    Attempt to gracefully shutdown server. It is possible to use returned Single to react.
    RequestMethod can be called periodically.
    
    Returns:
    
    a single to react on finished shutdown process
    
    See Also:
    
    start()
  - isRunning
```
boolean isRunning()
```
    Returns true if the server is currently running. Running server in stopping phase returns true until it is not fully stopped.
    
    Returns:
    
    true if server is running
  - context
```
Context context()
```
    Gets a WebServer context.
    
    Returns:
    
    a server context
  - readerContext
```
MessageBodyReaderContext readerContext()
```
    Get the parent MessageBodyReaderContext context.
    
    Returns:
    
    media body reader context
  - writerContext
```
MessageBodyWriterContext writerContext()
```
    Get the parent MessageBodyWriterContext context.
    
    Returns:
    
    media body writer context
  - port
```
default int port()
```
    Returns a port number the default server socket is bound to and is listening on; or -1 if unknown or not active.
    It is supported only when server is running.
    
    Returns:
    
    a listen port; or -1 if unknown or the default server socket is not active
  - port
```
int port(String socketName)
```
    Returns a port number an additional named server socket is bound to and is listening on; or -1 if unknown or not active.
    
    Parameters:
    
    socketName - the name of an additional named server socket
    
    Returns:
    
    a listen port; or -1 if socket name is unknown or the server socket is not active
  - hasTls
```
default boolean hasTls()
```
    Returns true if TLS is configured for the default socket.
    
    Returns:
    
    whether TLS is enabled for the default socket
  - hasTls
```
boolean hasTls(String socketName)
```
    Returns true if TLS is configured for the named socket.
    
    Parameters:
    
    socketName - the name of a socket
    
    Returns:
    
    whether TLS is enabled for the socket, returns false if the socket does not exists
  - updateTls
```
void updateTls(WebServerTls tls)
```
    Update the TLS configuration of the default socket DEFAULT_SOCKET_NAME.
    
    Parameters:
    
    tls - new TLS configuration
    
    Throws:
    
    IllegalStateException - if WebServerTls.enabled() returns false or if SocketConfiguration.ssl() returns null
  - updateTls
```
void updateTls(WebServerTls tls,
               String socketName)
```
    Update the TLS configuration of the named socket.
    
    Parameters:
    
    tls - new TLS configuration
    
    socketName - specific named socket name
    
    Throws:
    
    IllegalStateException - if WebServerTls.enabled() returns false or if SocketConfiguration.ssl() returns null
  - create
```
@Deprecated
static WebServer create(Supplier<? extends ServerConfiguration> configurationBuilder,
                        Routing routing)
```
    Deprecated.
    since 2.0.0 - please use create(io.helidon.webserver.Routing, io.helidon.config.Config) instead for instances based on Config, or builder(io.helidon.webserver.Routing) to configure server configuration by hand (as you would on SocketConfiguration.Builder now.
    
    Creates a new instance from a provided configuration and a routing.
    
    Parameters:
    
    configurationBuilder - a server configuration builder that will be built as a first step of this method execution; may be null
    
    routing - a routing instance
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    IllegalStateException - if none SPI implementation found
    
    NullPointerException - if 'routing' parameter is null
  - create
```
@Deprecated
static WebServer create(Supplier<? extends ServerConfiguration> configurationBuilder,
                        Supplier<? extends Routing> routingBuilder)
```
    Deprecated.
    since 2.0.0 - please use create(java.util.function.Supplier, io.helidon.config.Config) instead for instances based on Config, or builder(java.util.function.Supplier) to configure server configuration by hand (as you would on SocketConfiguration.Builder now.
    
    Creates new instance from provided configuration and routing.
    
    Parameters:
    
    configurationBuilder - a server configuration builder that will be built as a first step of this method execution; may be null
    
    routingBuilder - a routing builder that will be built as a second step of this method execution
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    IllegalStateException - if none SPI implementation found
    
    NullPointerException - if 'routingBuilder' parameter is null
  - create
```
@Deprecated
static WebServer create(ServerConfiguration configuration,
                        Supplier<? extends Routing> routingBuilder)
```
    Deprecated.
    since 2.0.0 - please use create(java.util.function.Supplier, io.helidon.config.Config) instead for instances based on Config, or builder(java.util.function.Supplier) to configure server configuration by hand (as you would on SocketConfiguration.Builder now.
    
    Creates new instance from provided configuration and routing.
    
    Parameters:
    
    configuration - a server configuration instance
    
    routingBuilder - a routing builder that will be built as a second step of this method execution
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    IllegalStateException - if none SPI implementation found
    
    NullPointerException - if 'routingBuilder' parameter is null
  - create
```
static WebServer create(Routing routing)
```
    Creates new instance from provided routing and default configuration.
    
    Parameters:
    
    routing - a routing instance
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    IllegalStateException - if none SPI implementation found
    
    NullPointerException - if 'routing' parameter is null
  - create
```
@Deprecated
static WebServer create(ServerConfiguration configuration,
                        Routing routing)
```
    Deprecated.
    since 2.0.0 - please use create(Routing, io.helidon.config.Config) instead for instances based on Config, or builder(Routing) to configure server configuration by hand (as you would on SocketConfiguration.Builder now.
    
    Creates new instance from provided configuration and routing.
    
    Parameters:
    
    configuration - a server configuration instance
    
    routing - a routing instance
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    NullPointerException - if 'routing' parameter is null
  - create
```
static WebServer create(Routing routing,
                        Config config)
```
    Creates new instance from provided configuration and routing.
    
    Parameters:
    
    routing - a routing instance
    
    config - configuration located on server configuration node
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    NullPointerException - if 'routing' parameter is null
    
    Since:
    
    2.0.0
  - create
```
static WebServer create(Supplier<Routing> routingBuilder,
                        Config config)
```
    Creates new instance from provided configuration and routing.
    
    Parameters:
    
    routingBuilder - a supplier of routing (such as Routing.Builder
    
    config - configuration located on server configuration node
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    NullPointerException - if 'routing' parameter is null
    
    Since:
    
    2.0.0
  - create
```
static WebServer create(Supplier<? extends Routing> routingBuilder)
```
    Creates new instance from provided routing and default configuration.
    
    Parameters:
    
    routingBuilder - a routing builder instance that will be built as a first step of this method execution
    
    Returns:
    
    a new web server instance
    
    Throws:
    
    IllegalStateException - if none SPI implementation found
    
    NullPointerException - if 'routing' parameter is null
  - builder
```
static WebServer.Builder builder(Supplier<? extends Routing> routingBuilder)
```
    Creates a builder of the WebServer.
    
    Parameters:
    
    routingBuilder - the routing builder; must not be null
    
    Returns:
    
    the builder
  - builder
```
static WebServer.Builder builder()
```
    Creates a fluent API builder of the WebServer. Before calling the WebServer.Builder.build() method, you should configure the default routing. If none is configured, all requests will end in 404.
    
    Returns:
    
    a new builder
  - builder
```
static WebServer.Builder builder(Routing routing)
```
    Creates a builder of the WebServer.
    
    Parameters:
    
    routing - the routing to use for the default port; must not be null
    
    Returns:
    
    the builder
    
    See Also:
    
    builder()

Interface WebServer

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_SOCKET_NAME

Method Detail

configuration

start

whenShutdown

shutdown

isRunning

context

readerContext

writerContext

port

port

hasTls

hasTls

updateTls

updateTls

create

create

create

create

create

create

create

create

builder

builder

builder