Package org.springframework.boot.web.embedded.netty

Class NettyReactiveWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.web.reactive.server.AbstractReactiveWebServerFactory

org.springframework.boot.web.embedded.netty.NettyReactiveWebServerFactory

All Implemented Interfaces:

ConfigurableReactiveWebServerFactory, ReactiveWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory

public class NettyReactiveWebServerFactory
extends AbstractReactiveWebServerFactory

ReactiveWebServerFactory that can be used to create NettyWebServers.

Since:

2.0.0

Author:

Brian Clozel, Moritz Halbritter

Constructor Summary

Constructors

Constructor	Description
NettyReactiveWebServerFactory()
NettyReactiveWebServerFactory(int port)

Method Summary

Modifier and Type	Method	Description
void	addRouteProviders(NettyRouteProvider... routeProviders)	Add NettyRouteProviders that should be applied, in order, before the handler for the Spring application.
void	addServerCustomizers(NettyServerCustomizer... serverCustomizers)	Add NettyServerCustomizers that should be applied while building the server.
Collection<NettyServerCustomizer>	getServerCustomizers()	Returns a mutable collection of the NettyServerCustomizers that will be applied to the Netty server builder.
Shutdown	getShutdown()	Returns the shutdown configuration that will be applied to the server.
WebServer	getWebServer(HttpHandler httpHandler)	Gets a new fully configured but paused WebServer instance.
void	setLifecycleTimeout(Duration lifecycleTimeout)	Set the maximum amount of time that should be waited when starting or stopping the server.
void	setResourceFactory(ReactorResourceFactory resourceFactory)	Set the ReactorResourceFactory to get the shared resources from.
void	setServerCustomizers(Collection<? extends NettyServerCustomizer> serverCustomizers)	Set NettyServerCustomizers that should be applied to the Netty server builder.
void	setShutdown(Shutdown shutdown)	Sets the shutdown configuration that will be applied to the server.
void	setUseForwardHeaders(boolean useForwardHeaders)	Set if x-forward-* headers should be processed.

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslBundles

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory

setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslBundles

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry

addErrorPages

Constructor Details

NettyReactiveWebServerFactory

public NettyReactiveWebServerFactory()

NettyReactiveWebServerFactory

public NettyReactiveWebServerFactory(int port)

Method Details

getWebServer

public WebServer getWebServer(HttpHandler httpHandler)

Description copied from interface: ReactiveWebServerFactory

Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).

Parameters:

httpHandler - the HTTP handler in charge of processing requests

Returns:

a fully configured and started WebServer

See Also:

• WebServer.stop()

getServerCustomizers

public Collection<NettyServerCustomizer> getServerCustomizers()

Returns a mutable collection of the NettyServerCustomizers that will be applied to the Netty server builder.

Returns:

the customizers that will be applied

setServerCustomizers

public void setServerCustomizers(Collection<? extends NettyServerCustomizer> serverCustomizers)

Set NettyServerCustomizers that should be applied to the Netty server builder. Calling this method will replace any existing customizers.

Parameters:

serverCustomizers - the customizers to set

addServerCustomizers

public void addServerCustomizers(NettyServerCustomizer... serverCustomizers)

Add NettyServerCustomizers that should be applied while building the server.

Parameters:

serverCustomizers - the customizers to add

addRouteProviders

public void addRouteProviders(NettyRouteProvider... routeProviders)

Add NettyRouteProviders that should be applied, in order, before the handler for the Spring application.

Parameters:

routeProviders - the route providers to add

setLifecycleTimeout

public void setLifecycleTimeout(Duration lifecycleTimeout)

Set the maximum amount of time that should be waited when starting or stopping the server.

Parameters:

lifecycleTimeout - the lifecycle timeout

setUseForwardHeaders

public void setUseForwardHeaders(boolean useForwardHeaders)

Set if x-forward-* headers should be processed.

Parameters:

useForwardHeaders - if x-forward headers should be used

Since:

2.1.0

setResourceFactory

public void setResourceFactory(ReactorResourceFactory resourceFactory)

Set the ReactorResourceFactory to get the shared resources from.

Parameters:

resourceFactory - the server resources

Since:

2.1.0

setShutdown

public void setShutdown(Shutdown shutdown)

Description copied from interface: ConfigurableWebServerFactory

Sets the shutdown configuration that will be applied to the server.

Specified by:

setShutdown in interface ConfigurableWebServerFactory

Overrides:

setShutdown in class AbstractConfigurableWebServerFactory

Parameters:

shutdown - the shutdown configuration

getShutdown

public Shutdown getShutdown()

Description copied from class: AbstractConfigurableWebServerFactory

Returns the shutdown configuration that will be applied to the server.

Overrides:

getShutdown in class AbstractConfigurableWebServerFactory

Returns:

the shutdown configuration