类 TomcatReactiveWebServerFactory
- java.lang.Object
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- org.springframework.boot.web.reactive.server.AbstractReactiveWebServerFactory
- org.springframework.boot.web.embedded.tomcat.TomcatReactiveWebServerFactory
- 所有已实现的接口:
ConfigurableTomcatWebServerFactory
,ConfigurableReactiveWebServerFactory
,ReactiveWebServerFactory
,ConfigurableWebServerFactory
,ErrorPageRegistry
,WebServerFactory
public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFactory implements ConfigurableTomcatWebServerFactory
ReactiveWebServerFactory
that can be used to create aTomcatWebServer
.- 从以下版本开始:
- 2.0.0
字段概要
字段 修饰符和类型 字段 说明 static String
DEFAULT_PROTOCOL
The class name of default protocol used.
构造器概要
构造器 构造器 说明 TomcatReactiveWebServerFactory()
Create a newTomcatServletWebServerFactory
instance.TomcatReactiveWebServerFactory(int port)
Create a newTomcatServletWebServerFactory
that listens for requests using the specified port.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
AddTomcatConnectorCustomizer
s that should be added to the TomcatConnector
.void
addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
AddTomcatContextCustomizer
s that should be added to the TomcatContext
.void
addContextLifecycleListeners(org.apache.catalina.LifecycleListener... contextLifecycleListeners)
AddLifecycleListener
s that should be added to the TomcatContext
.void
addEngineValves(org.apache.catalina.Valve... engineValves)
AddValve
s that should be applied to the TomcatEngine
.protected void
configureContext(org.apache.catalina.Context context)
Configure the TomcatContext
.protected void
customizeConnector(org.apache.catalina.connector.Connector connector)
Collection<org.apache.catalina.LifecycleListener>
getContextLifecycleListeners()
Returns a mutable collection of theLifecycleListener
s that will be applied to the TomcatContext
.List<org.apache.catalina.Valve>
getEngineValves()
Returns a mutable collection of theValve
s that will be applied to the TomcatEngine
.Collection<TomcatConnectorCustomizer>
getTomcatConnectorCustomizers()
Returns a mutable collection of theTomcatConnectorCustomizer
s that will be applied to the TomcatConnector
.Collection<TomcatContextCustomizer>
getTomcatContextCustomizers()
Returns a mutable collection of theTomcatContextCustomizer
s that will be applied to the TomcatContext
.protected TomcatWebServer
getTomcatWebServer(org.apache.catalina.startup.Tomcat tomcat)
Factory method called to create theTomcatWebServer
.Charset
getUriEncoding()
Returns the character encoding to use for URL decoding.WebServer
getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
Gets a new fully configured but pausedWebServer
instance.protected void
prepareContext(org.apache.catalina.Host host, org.springframework.http.server.reactive.TomcatHttpHandlerAdapter servlet)
void
setBackgroundProcessorDelay(int delay)
Sets the background processor delay in seconds.void
setBaseDirectory(File baseDirectory)
Set the Tomcat base directory.void
setContextLifecycleListeners(Collection<? extends org.apache.catalina.LifecycleListener> contextLifecycleListeners)
SetLifecycleListener
s that should be applied to the TomcatContext
.void
setProtocol(String protocol)
The Tomcat protocol to use when create theConnector
.void
setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
SetTomcatConnectorCustomizer
s that should be applied to the TomcatConnector
.void
setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers)
SetTomcatContextCustomizer
s that should be applied to the TomcatContext
.void
setUriEncoding(Charset uriEncoding)
Set the character encoding to use for URL decoding.从类继承的方法 org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslStoreProvider
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.boot.web.server.ConfigurableWebServerFactory
setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslStoreProvider
从接口继承的方法 org.springframework.boot.web.server.ErrorPageRegistry
addErrorPages
字段详细资料
DEFAULT_PROTOCOL
public static final String DEFAULT_PROTOCOL
The class name of default protocol used.- 另请参阅:
- 常量字段值
构造器详细资料
TomcatReactiveWebServerFactory
public TomcatReactiveWebServerFactory()
Create a newTomcatServletWebServerFactory
instance.
TomcatReactiveWebServerFactory
public TomcatReactiveWebServerFactory(int port)
Create a newTomcatServletWebServerFactory
that listens for requests using the specified port.- 参数:
port
- the port to listen on
方法详细资料
getWebServer
public WebServer getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
从接口复制的说明: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).- 指定者:
getWebServer
在接口中ReactiveWebServerFactory
- 参数:
httpHandler
- the HTTP handler in charge of processing requests- 返回:
- a fully configured and started
WebServer
- 另请参阅:
WebServer.stop()
prepareContext
protected void prepareContext(org.apache.catalina.Host host, org.springframework.http.server.reactive.TomcatHttpHandlerAdapter servlet)
configureContext
protected void configureContext(org.apache.catalina.Context context)
Configure the TomcatContext
.- 参数:
context
- the Tomcat context
customizeConnector
protected void customizeConnector(org.apache.catalina.connector.Connector connector)
setBaseDirectory
public void setBaseDirectory(File baseDirectory)
从接口复制的说明:ConfigurableTomcatWebServerFactory
Set the Tomcat base directory. If not specified a temporary directory will be used.- 指定者:
setBaseDirectory
在接口中ConfigurableTomcatWebServerFactory
- 参数:
baseDirectory
- the tomcat base directory
setBackgroundProcessorDelay
public void setBackgroundProcessorDelay(int delay)
从接口复制的说明:ConfigurableTomcatWebServerFactory
Sets the background processor delay in seconds.- 指定者:
setBackgroundProcessorDelay
在接口中ConfigurableTomcatWebServerFactory
- 参数:
delay
- the delay in seconds
setTomcatContextCustomizers
public void setTomcatContextCustomizers(Collection<? extends TomcatContextCustomizer> tomcatContextCustomizers)
SetTomcatContextCustomizer
s that should be applied to the TomcatContext
. Calling this method will replace any existing customizers.- 参数:
tomcatContextCustomizers
- the customizers to set
getTomcatContextCustomizers
public Collection<TomcatContextCustomizer> getTomcatContextCustomizers()
Returns a mutable collection of theTomcatContextCustomizer
s that will be applied to the TomcatContext
.- 返回:
- the listeners that will be applied
addContextCustomizers
public void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
AddTomcatContextCustomizer
s that should be added to the TomcatContext
.- 指定者:
addContextCustomizers
在接口中ConfigurableTomcatWebServerFactory
- 参数:
tomcatContextCustomizers
- the customizers to add
setTomcatConnectorCustomizers
public void setTomcatConnectorCustomizers(Collection<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
SetTomcatConnectorCustomizer
s that should be applied to the TomcatConnector
. Calling this method will replace any existing customizers.- 参数:
tomcatConnectorCustomizers
- the customizers to set
addConnectorCustomizers
public void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
AddTomcatConnectorCustomizer
s that should be added to the TomcatConnector
.- 指定者:
addConnectorCustomizers
在接口中ConfigurableTomcatWebServerFactory
- 参数:
tomcatConnectorCustomizers
- the customizers to add
getTomcatConnectorCustomizers
public Collection<TomcatConnectorCustomizer> getTomcatConnectorCustomizers()
Returns a mutable collection of theTomcatConnectorCustomizer
s that will be applied to the TomcatConnector
.- 返回:
- the customizers that will be applied
addEngineValves
public void addEngineValves(org.apache.catalina.Valve... engineValves)
从接口复制的说明:ConfigurableTomcatWebServerFactory
AddValve
s that should be applied to the TomcatEngine
.- 指定者:
addEngineValves
在接口中ConfigurableTomcatWebServerFactory
- 参数:
engineValves
- the valves to add
getEngineValves
public List<org.apache.catalina.Valve> getEngineValves()
Returns a mutable collection of theValve
s that will be applied to the TomcatEngine
.- 返回:
- the engine valves that will be applied
setUriEncoding
public void setUriEncoding(Charset uriEncoding)
Set the character encoding to use for URL decoding. If not specified 'UTF-8' will be used.- 指定者:
setUriEncoding
在接口中ConfigurableTomcatWebServerFactory
- 参数:
uriEncoding
- the uri encoding to set
getUriEncoding
public Charset getUriEncoding()
Returns the character encoding to use for URL decoding.- 返回:
- the URI encoding
setContextLifecycleListeners
public void setContextLifecycleListeners(Collection<? extends org.apache.catalina.LifecycleListener> contextLifecycleListeners)
SetLifecycleListener
s that should be applied to the TomcatContext
. Calling this method will replace any existing listeners.- 参数:
contextLifecycleListeners
- the listeners to set
getContextLifecycleListeners
public Collection<org.apache.catalina.LifecycleListener> getContextLifecycleListeners()
Returns a mutable collection of theLifecycleListener
s that will be applied to the TomcatContext
.- 返回:
- the context lifecycle listeners that will be applied
addContextLifecycleListeners
public void addContextLifecycleListeners(org.apache.catalina.LifecycleListener... contextLifecycleListeners)
AddLifecycleListener
s that should be added to the TomcatContext
.- 参数:
contextLifecycleListeners
- the listeners to add
getTomcatWebServer
protected TomcatWebServer getTomcatWebServer(org.apache.catalina.startup.Tomcat tomcat)
Factory method called to create theTomcatWebServer
. Subclasses can override this method to return a differentTomcatWebServer
or apply additional processing to the Tomcat server.- 参数:
tomcat
- the Tomcat server.- 返回:
- a new
TomcatWebServer
instance
setProtocol
public void setProtocol(String protocol)
The Tomcat protocol to use when create theConnector
.- 参数:
protocol
- the protocol- 另请参阅:
Connector(String)