Class NettyReactiveWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

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

org.springframework.boot.reactor.netty.NettyReactiveWebServerFactory

All Implemented Interfaces:

org.springframework.boot.web.error.ErrorPageRegistry, org.springframework.boot.web.server.ConfigurableWebServerFactory, org.springframework.boot.web.server.reactive.ConfigurableReactiveWebServerFactory, org.springframework.boot.web.server.reactive.ReactiveWebServerFactory, org.springframework.boot.web.server.WebServerFactory

public class NettyReactiveWebServerFactory
extends org.springframework.boot.web.server.reactive.AbstractReactiveWebServerFactory

ReactiveWebServerFactory that can be used to create NettyWebServers.

Since:

4.0.0

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.
org.springframework.boot.web.server.WebServer	getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
void	setLifecycleTimeout(@Nullable Duration lifecycleTimeout)	Set the maximum amount of time that should be waited when starting or stopping the server.
void	setResourceFactory(@Nullable org.springframework.http.client.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	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, getServerNameSslBundles, getShutdown, getSsl, getSslBundle, getSslBundles, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles

Methods inherited from class 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, setShutdown, setSsl, setSslBundles

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

addErrorPages

Constructor Details

NettyReactiveWebServerFactory

public NettyReactiveWebServerFactory()

NettyReactiveWebServerFactory

public NettyReactiveWebServerFactory(int port)

Method Details

getWebServer

public org.springframework.boot.web.server.WebServer getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)

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(@Nullable 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

setResourceFactory

public void setResourceFactory(@Nullable org.springframework.http.client.ReactorResourceFactory resourceFactory)

Set the ReactorResourceFactory to get the shared resources from.

Parameters:

resourceFactory - the server resources