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 createNettyWebServer
s.- Since:
- 2.0.0
Constructor Summary
Constructors Constructor Description NettyReactiveWebServerFactory()
NettyReactiveWebServerFactory(int port)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addServerCustomizers(NettyServerCustomizer... serverCustomizers)
AddNettyServerCustomizer
s that should applied while building the server.Collection<NettyServerCustomizer>
getServerCustomizers()
Returns a mutable collection of theNettyServerCustomizer
s that will be applied to the Netty server builder.WebServer
getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
Gets a new fully configured but pausedWebServer
instance.void
setLifecycleTimeout(Duration lifecycleTimeout)
Set the maximum amount of time that should be waited when starting or stopping the server.void
setResourceFactory(org.springframework.http.client.reactive.ReactorResourceFactory resourceFactory)
Set theReactorResourceFactory
to get the shared resources from.void
setServerCustomizers(Collection<? extends NettyServerCustomizer> serverCustomizers)
SetNettyServerCustomizer
s 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, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslStoreProvider
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, setSslStoreProvider
Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry
addErrorPages
Constructor Detail
NettyReactiveWebServerFactory
public NettyReactiveWebServerFactory()
NettyReactiveWebServerFactory
public NettyReactiveWebServerFactory(int port)
Method Detail
getWebServer
public WebServer getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
Description copied from interface:ReactiveWebServerFactory
Gets a new fully configured but pausedWebServer
instance. Clients should not be able to connect to the returned server untilWebServer.start()
is called (which happens when theApplicationContext
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 theNettyServerCustomizer
s that will be applied to the Netty server builder.- Returns:
- the customizers that will be applied
setServerCustomizers
public void setServerCustomizers(Collection<? extends NettyServerCustomizer> serverCustomizers)
SetNettyServerCustomizer
s 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)
AddNettyServerCustomizer
s that should applied while building the server.- Parameters:
serverCustomizers
- the customizers 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(org.springframework.http.client.reactive.ReactorResourceFactory resourceFactory)
Set theReactorResourceFactory
to get the shared resources from.- Parameters:
resourceFactory
- the server resources- Since:
- 2.1.0