- All Superinterfaces:
- ListenerConfig,- Prototype.Api,- Prototype.Factory<WebServer>
- All Known Implementing Classes:
- WebServerConfig.BuilderBase.WebServerConfigImpl
WebServer configuration bean.
 See 
WebServer.create(java.util.function.Consumer).- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic classFluent API builder forWebServer.static classWebServerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>, PROTOTYPE extends WebServerConfig> Fluent API builder base forWebServer.
- 
Method SummaryModifier and TypeMethodDescriptionstatic WebServerConfig.Builderbuilder()Create a new fluent API builder to customize configuration.static WebServerConfig.Builderbuilder(WebServerConfig instance) Create a new fluent API builder from an existing instance.default voidconfigureSocket(ServerSocket socket) Update the server socket with configured socket options.static WebServerConfigcreate()Create a new instance with default values.static WebServerConfigDeprecated.static WebServerConfigCreate a new instance from configuration.features()Server features allow customization of the server, listeners, or routings.Routing for additional sockets.Context for the WebServer, if none defined, a new one will be created with global context as the root.booleanWhen true the webserver registers a shutdown hook with the JVM Runtime.sockets()Socket configurations.Methods inherited from interface io.helidon.webserver.ListenerConfigaddress, backlog, concurrencyLimit, connectionConfig, connectionOptions, connectionSelectors, contentEncoding, directHandlers, enableProxyProtocol, errorHandling, host, idleConnectionPeriod, idleConnectionTimeout, ignoreInvalidNamedRouting, listenerContext, listenerSocketOptions, maxConcurrentRequests, maxInMemoryEntity, maxPayloadSize, maxTcpConnections, mediaContext, name, port, protocols, receiveBufferSize, requestedUriDiscoveryContext, restoreResponseHeaders, routing, routings, shutdownGracePeriod, smartAsyncWrites, tls, writeBufferSize, writeQueueLengthMethods inherited from interface io.helidon.builder.api.Prototype.Factorybuild
- 
Method Details- 
builderCreate a new fluent API builder to customize configuration.- Returns:
- a new builder
 
- 
builderCreate a new fluent API builder from an existing instance.- Parameters:
- instance- an existing instance used as a base for the builder
- Returns:
- a builder based on an instance
 
- 
createCreate a new instance from configuration.- Parameters:
- config- used to configure the new instance
- Returns:
- a new instance configured from configuration
 
- 
createDeprecated.Create a new instance from configuration.- Parameters:
- config- used to configure the new instance
- Returns:
- a new instance configured from configuration
 
- 
createCreate a new instance with default values.- Returns:
- a new instance
 
- 
shutdownHookboolean shutdownHook()When true the webserver registers a shutdown hook with the JVM Runtime.Defaults to true. Set this to false such that a shutdown hook is not registered. - Returns:
- whether to register a shutdown hook
 
- 
socketsMap<String,ListenerConfig> sockets()Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly.- Returns:
- map of listener configurations, except for the default one
 
- 
namedRoutingsRouting for additional sockets. Note that socket named "@default" cannot be used, configure the routing on the server directly.- Returns:
- map of routing
 
- 
featuresList<ServerFeature> features()Server features allow customization of the server, listeners, or routings.- Returns:
- server features
 
- 
serverContextContext for the WebServer, if none defined, a new one will be created with global context as the root.- Returns:
- server context
 
- 
configureSocketUpdate the server socket with configured socket options.- Parameters:
- socket- socket to update
 
 
- 
create(io.helidon.config.Config)