Module io.helidon.webserver

Package io.helidon.webserver

Class WebServerConfig.BuilderBase.WebServerConfigImpl

java.lang.Object

io.helidon.webserver.ListenerConfig.BuilderBase.ListenerConfigImpl

io.helidon.webserver.WebServerConfig.BuilderBase.WebServerConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<WebServer>, ListenerConfig, WebServerConfig, Supplier<WebServer>

Enclosing class:

WebServerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

protected static class WebServerConfig.BuilderBase.WebServerConfigImpl
extends ListenerConfig.BuilderBase.ListenerConfigImpl
implements WebServerConfig, Supplier<WebServer>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.ListenerConfig

ListenerConfig.Builder, ListenerConfig.BuilderBase<BUILDER extends ListenerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ListenerConfig>

Nested classes/interfaces inherited from interface io.helidon.webserver.WebServerConfig

WebServerConfig.Builder, WebServerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebServerConfigImpl(WebServerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
WebServer	build()	Create a new instance of the runtime type from this config object.
default void	configureSocket(ServerSocket socket)	Update the server socket with configured socket options.
boolean	equals(Object o)
List<ServerFeature>	features()	Server features allow customization of the server, listeners, or routings.
WebServer	get()
int	hashCode()
Map<String,List<Builder<?,? extends Routing>>>	namedRoutings()	Routing for additional sockets.
Optional<Context>	serverContext()	Context for the WebServer, if none defined, a new one will be created with global context as the root.
boolean	shutdownHook()	When true the webserver registers a shutdown hook with the JVM Runtime.
Map<String,ListenerConfig>	sockets()	Socket configurations.
String	toString()

Methods inherited from class io.helidon.webserver.ListenerConfig.BuilderBase.ListenerConfigImpl

address, 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, writeQueueLength

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.webserver.ListenerConfig

address, 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, writeQueueLength

Constructor Details

WebServerConfigImpl

protected WebServerConfigImpl(WebServerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public WebServer build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<WebServer>

Returns:

new configured runtime instance

get

public WebServer get()

Specified by:

get in interface Supplier<WebServer>

shutdownHook

public boolean shutdownHook()

Description copied from interface: WebServerConfig

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.

Specified by:

shutdownHook in interface WebServerConfig

Returns:

whether to register a shutdown hook

sockets

public Map<String,ListenerConfig> sockets()

Description copied from interface: WebServerConfig

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly.

Specified by:

sockets in interface WebServerConfig

Returns:

map of listener configurations, except for the default one

namedRoutings

public Map<String,List<Builder<?,? extends Routing>>> namedRoutings()

Description copied from interface: WebServerConfig

Routing for additional sockets. Note that socket named "@default" cannot be used, configure the routing on the server directly.

Specified by:

namedRoutings in interface WebServerConfig

Returns:

map of routing

features

public List<ServerFeature> features()

Description copied from interface: WebServerConfig

Server features allow customization of the server, listeners, or routings.

Specified by:

features in interface WebServerConfig

Returns:

server features

serverContext

public Optional<Context> serverContext()

Description copied from interface: WebServerConfig

Context for the WebServer, if none defined, a new one will be created with global context as the root.

Specified by:

serverContext in interface WebServerConfig

Returns:

server context

toString

public String toString()

Overrides:

toString in class ListenerConfig.BuilderBase.ListenerConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class ListenerConfig.BuilderBase.ListenerConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ListenerConfig.BuilderBase.ListenerConfigImpl

configureSocket

default void configureSocket(ServerSocket socket)

Update the server socket with configured socket options.

Parameters:

socket - socket to update