Class TomcatReactiveWebServerFactory

java.lang.Object

org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

org.springframework.boot.tomcat.TomcatWebServerFactory

org.springframework.boot.tomcat.reactive.TomcatReactiveWebServerFactory

All Implemented Interfaces:

ConfigurableTomcatWebServerFactory, ErrorPageRegistry, ConfigurableWebServerFactory, ConfigurableReactiveWebServerFactory, ReactiveWebServerFactory, WebServerFactory

public class TomcatReactiveWebServerFactory
extends TomcatWebServerFactory
implements ConfigurableTomcatWebServerFactory, ConfigurableReactiveWebServerFactory

ReactiveWebServerFactory that can be used to create a TomcatWebServer.

Since:

4.0.0

Author:

Brian Clozel, HaiTao Zhang, Moritz Halbritter, Scott Frederick

Nested Class Summary

Nested classes/interfaces inherited from class AbstractConfigurableWebServerFactory

AbstractConfigurableWebServerFactory.TempDirs

Field Summary

Fields inherited from class TomcatWebServerFactory

DEFAULT_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
TomcatReactiveWebServerFactory()	Create a new TomcatReactiveWebServerFactory instance.
TomcatReactiveWebServerFactory(int port)	Create a new TomcatReactiveWebServerFactory that listens for requests using the specified port.

Method Summary

Modifier and Type	Method	Description
protected void	configureContext(Context context)	Configure the Tomcat Context.
protected TomcatWebServer	getTomcatWebServer(Tomcat tomcat)	Factory method called to create the TomcatWebServer.
WebServer	getWebServer(HttpHandler httpHandler)	Gets a new fully configured but paused WebServer instance.
protected void	prepareContext(Host host, TomcatHttpHandlerAdapter servlet)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.0 for removal in 4.3.0 in favor of prepareContext(Host, TomcatHttpHandlerAdapter, TempDirs)
protected void	prepareContext(Host host, TomcatHttpHandlerAdapter servlet, AbstractConfigurableWebServerFactory.TempDirs tempDirs)	Prepares the context.

Methods inherited from class TomcatWebServerFactory

addAdditionalConnectors, addConnectorCustomizers, addContextCustomizers, addContextLifecycleListeners, addContextValves, addEngineValves, addProtocolHandlerCustomizers, createTomcat, createTomcat, customizeConnector, getAdditionalConnectors, getBackgroundProcessorDelay, getBaseDirectory, getConnectorCustomizers, getContextCustomizers, getContextLifecycleListeners, getContextValves, getEngineValves, getProtocol, getProtocolHandlerCustomizers, getUriEncoding, isDisableMBeanRegistry, setAdditionalConnectors, setBackgroundProcessorDelay, setBaseDirectory, setConnectorCustomizers, setContextCustomizers, setContextLifecycleListeners, setContextValves, setDisableMBeanRegistry, setEngineValves, setProtocol, setProtocolHandlerCustomizers, setUriEncoding, setUseApr

Methods inherited from class 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 ConfigurableTomcatWebServerFactory

addConnectorCustomizers, addContextCustomizers, addEngineValves, addProtocolHandlerCustomizers, setBackgroundProcessorDelay, setBaseDirectory, setDisableMBeanRegistry, setUriEncoding, setUseApr

Methods inherited from interface ConfigurableWebServerFactory

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

Methods inherited from interface ErrorPageRegistry

addErrorPages

Constructor Details

TomcatReactiveWebServerFactory

public TomcatReactiveWebServerFactory()

Create a new TomcatReactiveWebServerFactory instance.

TomcatReactiveWebServerFactory

public TomcatReactiveWebServerFactory(int port)

Create a new TomcatReactiveWebServerFactory that listens for requests using the specified port.

Parameters:

port - the port to listen on

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).

Specified by:

getWebServer in interface ReactiveWebServerFactory

Parameters:

httpHandler - the HTTP handler in charge of processing requests

Returns:

a fully configured and started WebServer

See Also:

• WebServer.stop()

prepareContext

@Deprecated(forRemoval=true,
            since="4.1.0")
protected void prepareContext(Host host,
 TomcatHttpHandlerAdapter servlet)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.0 for removal in 4.3.0 in favor of prepareContext(Host, TomcatHttpHandlerAdapter, TempDirs)

Prepares the context.

Parameters:

host - the host

servlet - the servlet adapter

prepareContext

protected void prepareContext(Host host,
 TomcatHttpHandlerAdapter servlet,
 AbstractConfigurableWebServerFactory.TempDirs tempDirs)

Prepares the context.

Parameters:

host - the host

servlet - the servlet adapter

tempDirs - to manage temporary directories

Since:

4.1.0

configureContext

protected void configureContext(Context context)

Configure the Tomcat Context.

Parameters:

context - the Tomcat context

getTomcatWebServer

protected TomcatWebServer getTomcatWebServer(Tomcat tomcat)

Factory method called to create the TomcatWebServer. Subclasses can override this method to return a different TomcatWebServer or apply additional processing to the Tomcat server.

Parameters:

tomcat - the Tomcat server.

Returns:

a new TomcatWebServer instance