クラス TomcatServletWebServerFactory
java.lang.ObjectSE
org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
- 実装されたすべてのインターフェース:
Aware
、ConfigurableTomcatWebServerFactory
、ConfigurableWebServerFactory
、ErrorPageRegistry
、WebServerFactory
、ConfigurableServletWebServerFactory
、ServletWebServerFactory
、WebListenerRegistry
、ResourceLoaderAware
public class TomcatServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableTomcatWebServerFactory, ResourceLoaderAware
TomcatWebServer
の作成に使用できる AbstractServletWebServerFactory
。Spring の ServletContextInitializer
または Tomcat LifecycleListener
を使用して初期化できます。特に明示的に設定されていない限り、このファクトリはポート 8080 で HTTP リクエストをリッスンするコンテナーを作成します。
- 導入:
- 2.0.0
- 作成者:
- Phillip Webb, Dave Syer, Brock Mills, Stephane Nicoll, Andy Wilkinson, Edd ú Mel é ndez, Christoffer Sawicki, Dawid Antecki, Moritz Halbritter, Scott Frederick
- 関連事項:
フィールドサマリー
コンストラクターのサマリー
コンストラクター説明新しいTomcatServletWebServerFactory
インスタンスを作成します。TomcatServletWebServerFactory
(int port) 指定されたポートを使用してリクエストをリッスンする新しいTomcatServletWebServerFactory
を作成します。TomcatServletWebServerFactory
(StringSE contextPath, int port) 指定されたコンテキストパスとポートで新しいTomcatServletWebServerFactory
を作成します。方法の概要
修飾子と型メソッド説明void
addAdditionalTomcatConnectors
(Connector... connectors) デフォルトのコネクターに加えてConnector
を追加します。void
addConnectorCustomizers
(TomcatConnectorCustomizer... tomcatConnectorCustomizers) TomcatConnector
に追加する必要があるTomcatConnectorCustomizer
を追加します。void
addContextCustomizers
(TomcatContextCustomizer... tomcatContextCustomizers) TomcatContext
に追加する必要があるTomcatContextCustomizer
を追加します。void
addContextLifecycleListeners
(LifecycleListener... contextLifecycleListeners) TomcatContext
に追加する必要があるLifecycleListener
を追加します。void
addContextValves
(Valve... contextValves) void
addEngineValves
(Valve... engineValves) void
addProtocolHandlerCustomizers
(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers) TomcatConnector
に追加する必要があるTomcatProtocolHandlerCustomizer
を追加します。void
addTldSkipPatterns
(StringSE... patterns) jar に一致するパターンを追加して、TLD スキャンで無視します。protected void
configureContext
(Context context, ServletContextInitializer[] initializers) TomcatContext
を構成します。protected void
customizeConnector
(Connector connector) Tomcat に追加されるConnector
の可変コレクションを返します。TomcatContext
に適用されるLifecycleListener
の可変コレクションを返します。TLD スキャンで無視する jar に一致するパターンの可変セットを返します。TomcatConnector
に適用されるTomcatConnectorCustomizer
の可変コレクションを返します。TomcatContext
に適用されるTomcatContextCustomizer
の可変コレクションを返します。TomcatConnector
に適用されるTomcatProtocolHandlerCustomizer
の可変コレクションを返します。protected TomcatWebServer
getTomcatWebServer
(Tomcat tomcat) TomcatWebServer
を作成するために呼び出されるファクトリメソッド。URL デコードに使用する文字エンコードを返します。getWebServer
(ServletContextInitializer... initializers) 完全に構成済みで一時停止された新しいWebServer
インスタンスを取得します。protected void
postProcessContext
(Context context) TomcatContext
を Tomcat サーバーで使用する前に後処理します。protected void
prepareContext
(Host host, ServletContextInitializer[] initializers) void
setBackgroundProcessorDelay
(int delay) バックグラウンドプロセッサーの遅延を秒単位で設定します。void
setBaseDirectory
(FileSE baseDirectory) Tomcat のベースディレクトリを設定します。void
setContextLifecycleListeners
(CollectionSE<? extends LifecycleListener> contextLifecycleListeners) TomcatContext
に適用するLifecycleListener
を設定します。void
setContextValves
(CollectionSE<? extends Valve> contextValves) void
setDisableMBeanRegistry
(boolean disableMBeanRegistry) サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。void
setEngineValves
(CollectionSE<? extends Valve> engineValves) void
setProtocol
(StringSE protocol) Connector
を作成するときに使用する Tomcat プロトコル。void
setResourceLoader
(ResourceLoader resourceLoader) void
setTldSkipPatterns
(CollectionSE<StringSE> patterns) jar に一致するパターンを設定して、TLD スキャンで無視します。void
setTomcatConnectorCustomizers
(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) TomcatConnector
に適用するTomcatConnectorCustomizer
を設定します。void
setTomcatContextCustomizers
(CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers) TomcatContext
に適用するTomcatContextCustomizer
を設定します。void
setTomcatProtocolHandlerCustomizers
(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer) TomcatConnector
に適用するTomcatProtocolHandlerCustomizer
を設定します。void
setUriEncoding
(CharsetSE uriEncoding) URL デコードに使用する文字エンコードを設定します。クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたメソッド
addCookieSameSiteSuppliers, addInitializers, addMimeMappings, addWebListeners, getContextPath, getCookieSameSiteSuppliers, getDisplayName, getDocumentRoot, getInitParameters, getJsp, getLocaleCharsetMappings, getMimeMappings, getSession, getUrlsOfJarsWithMetaInfResources, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir, getWebListenerClassNames, isRegisterDefaultServlet, mergeInitializers, setContextPath, setCookieSameSiteSuppliers, setDisplayName, setDocumentRoot, setInitializers, setInitParameters, setJsp, setLocaleCharsetMappings, setMimeMappings, setRegisterDefaultServlet, setSession, shouldRegisterJspServlet
クラス 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
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.boot.web.server.ConfigurableWebServerFactory から継承されたメソッド
setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setShutdown, setSsl, setSslBundles
インターフェース org.springframework.boot.web.server.ErrorPageRegistry から継承されたメソッド
addErrorPages
フィールドの詳細
DEFAULT_PROTOCOL
使用されるデフォルトプロトコルのクラス名。- 関連事項:
コンストラクターの詳細
TomcatServletWebServerFactory
public TomcatServletWebServerFactory()新しいTomcatServletWebServerFactory
インスタンスを作成します。TomcatServletWebServerFactory
public TomcatServletWebServerFactory(int port) 指定されたポートを使用してリクエストをリッスンする新しいTomcatServletWebServerFactory
を作成します。- パラメーター:
port
- リッスンするポート
TomcatServletWebServerFactory
指定されたコンテキストパスとポートで新しいTomcatServletWebServerFactory
を作成します。- パラメーター:
contextPath
- ルートコンテキストパスport
- リッスンするポート
メソッドの詳細
getWebServer
インターフェースからコピーされた説明:ServletWebServerFactory
完全に構成されましたが一時停止された新しいWebServer
インスタンスを取得します。クライアントは、WebServer.start()
が呼び出されるまで(ApplicationContext
が完全にリフレッシュされると発生します)、返されたサーバーに接続できません。- 次で指定:
- インターフェース
ServletWebServerFactory
のgetWebServer
- パラメーター:
initializers
- サーバーの起動時に適用されるServletContextInitializer
- 戻り値:
- 完全に構成および開始された
WebServer
- 関連事項:
prepareContext
customizeConnector
configureContext
TomcatContext
を構成します。- パラメーター:
context
- Tomcat コンテキストinitializers
- 適用する初期化子
postProcessContext
- パラメーター:
context
- TomcatContext
getTomcatWebServer
TomcatWebServer
を作成するために呼び出されるファクトリメソッド。サブクラスはこのメソッドをオーバーライドして、異なるTomcatWebServer
を返すか、Tomcat サーバーに追加処理を適用できます。- パラメーター:
tomcat
- Tomcat サーバー。- 戻り値:
- 新しい
TomcatWebServer
インスタンス
setResourceLoader
- 次で指定:
- インターフェース
ResourceLoaderAware
のsetResourceLoader
setBaseDirectory
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
Tomcat のベースディレクトリを設定します。指定しない場合、一時ディレクトリが使用されます。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のsetBaseDirectory
- パラメーター:
baseDirectory
- Tomcat ベースディレクトリ
getTldSkipPatterns
TLD スキャンで無視する jar に一致するパターンの可変セットを返します。- 戻り値:
- TLD スキャンで無視する jar のセット
setTldSkipPatterns
jar に一致するパターンを設定して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。デフォルトでは、そのソースから描画されたリストになります。- パラメーター:
patterns
- TLD などをスキャンするときにスキップする jar パターン
addTldSkipPatterns
jar に一致するパターンを追加して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。- パラメーター:
patterns
- TLD などをスキャンするときにスキップする追加の jar パターン
setProtocol
Connector
を作成するときに使用する Tomcat プロトコル。- パラメーター:
protocol
- プロトコル- 関連事項:
setEngineValves
- パラメーター:
engineValves
- 設定するバルブ
getEngineValves
- 戻り値:
- 適用されるエンジンバルブ
addEngineValves
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のaddEngineValves
- パラメーター:
engineValves
- 追加するバルブ
setContextValves
- パラメーター:
contextValves
- 設定するバルブ
getContextValves
- 戻り値:
- 適用されるコンテキストバルブ
- 関連事項:
addContextValves
- パラメーター:
contextValves
- 追加するバルブ
setContextLifecycleListeners
public void setContextLifecycleListeners(CollectionSE<? extends LifecycleListener> contextLifecycleListeners) TomcatContext
に適用するLifecycleListener
を設定します。このメソッドを呼び出すと、既存のリスナーが置き換えられます。- パラメーター:
contextLifecycleListeners
- 設定するリスナー
getContextLifecycleListeners
TomcatContext
に適用されるLifecycleListener
の可変コレクションを返します。- 戻り値:
- 適用されるコンテキストライフサイクルリスナー
addContextLifecycleListeners
TomcatContext
に追加する必要があるLifecycleListener
を追加します。- パラメーター:
contextLifecycleListeners
- 追加するリスナー
setTomcatContextCustomizers
public void setTomcatContextCustomizers(CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers) TomcatContext
に適用するTomcatContextCustomizer
を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
tomcatContextCustomizers
- 設定するカスタマイザー
getTomcatContextCustomizers
TomcatContext
に適用されるTomcatContextCustomizer
の可変コレクションを返します。- 戻り値:
- 適用されるリスナー
addContextCustomizers
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
TomcatContext
に追加する必要があるTomcatContextCustomizer
を追加します。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のaddContextCustomizers
- パラメーター:
tomcatContextCustomizers
- 追加するカスタマイザー
setTomcatConnectorCustomizers
public void setTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) TomcatConnector
に適用するTomcatConnectorCustomizer
を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
tomcatConnectorCustomizers
- 設定するカスタマイザー
addConnectorCustomizers
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
TomcatConnector
に追加する必要があるTomcatConnectorCustomizer
を追加します。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のaddConnectorCustomizers
- パラメーター:
tomcatConnectorCustomizers
- 追加するカスタマイザー
getTomcatConnectorCustomizers
TomcatConnector
に適用されるTomcatConnectorCustomizer
の可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
setTomcatProtocolHandlerCustomizers
public void setTomcatProtocolHandlerCustomizers(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer) TomcatConnector
に適用するTomcatProtocolHandlerCustomizer
を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
tomcatProtocolHandlerCustomizer
- 設定するカスタマイザー- 導入:
- 2.2.0
addProtocolHandlerCustomizers
public void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers) TomcatConnector
に追加する必要があるTomcatProtocolHandlerCustomizer
を追加します。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のaddProtocolHandlerCustomizers
- パラメーター:
tomcatProtocolHandlerCustomizers
- 追加するカスタマイザー- 導入:
- 2.2.0
getTomcatProtocolHandlerCustomizers
TomcatConnector
に適用されるTomcatProtocolHandlerCustomizer
の可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
- 導入:
- 2.2.0
addAdditionalTomcatConnectors
デフォルトのコネクターに加えてConnector
を追加します。SSL または AJP の場合。Connector customizers
は、この方法で追加されたコネクターには適用されません。- パラメーター:
connectors
- 追加するコネクター
getAdditionalTomcatConnectors
Tomcat に追加されるConnector
の可変コレクションを返します。- 戻り値:
- additionalTomcatConnectors
setUriEncoding
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
URL デコードに使用する文字エンコードを設定します。指定しない場合、"UTF-8" が使用されます。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のsetUriEncoding
- パラメーター:
uriEncoding
- 設定する URI エンコーディング
getUriEncoding
URL デコードに使用する文字エンコードを返します。- 戻り値:
- URI エンコーディング
setBackgroundProcessorDelay
public void setBackgroundProcessorDelay(int delay) インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactory
バックグラウンドプロセッサーの遅延を秒単位で設定します。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactory
のsetBackgroundProcessorDelay
- パラメーター:
delay
- 秒単位の遅延
setDisableMBeanRegistry
public void setDisableMBeanRegistry(boolean disableMBeanRegistry) サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。- パラメーター:
disableMBeanRegistry
- MBean レジストリを無効にするかどうか- 導入:
- 2.2.0