クラス 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) Tomcat- Connectorに追加する必要がある- TomcatConnectorCustomizerを追加します。- void- addContextCustomizers- (TomcatContextCustomizer... tomcatContextCustomizers) Tomcat- Contextに追加する必要がある- TomcatContextCustomizerを追加します。- void- addContextLifecycleListeners- (LifecycleListener... contextLifecycleListeners) Tomcat- Contextに追加する必要がある- LifecycleListenerを追加します。- void- addContextValves- (Valve... contextValves) - void- addEngineValves- (Valve... engineValves) - void- addProtocolHandlerCustomizers- (TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers) Tomcat- Connectorに追加する必要がある- TomcatProtocolHandlerCustomizerを追加します。- void- addTldSkipPatterns- (StringSE... patterns) jar に一致するパターンを追加して、TLD スキャンで無視します。- protected void- configureContext- (Context context, ServletContextInitializer[] initializers) Tomcat- Contextを構成します。- protected void- customizeConnector- (Connector connector) Tomcat に追加される- Connectorの可変コレクションを返します。Tomcat- Contextに適用される- LifecycleListenerの可変コレクションを返します。TLD スキャンで無視する jar に一致するパターンの可変セットを返します。Tomcat- Connectorに適用される- TomcatConnectorCustomizerの可変コレクションを返します。Tomcat- Contextに適用される- TomcatContextCustomizerの可変コレクションを返します。Tomcat- Connectorに適用される- TomcatProtocolHandlerCustomizerの可変コレクションを返します。- protected TomcatWebServer- getTomcatWebServer- (Tomcat tomcat) - TomcatWebServerを作成するために呼び出されるファクトリメソッド。URL デコードに使用する文字エンコードを返します。- getWebServer- (ServletContextInitializer... initializers) 完全に構成済みで一時停止された新しい- WebServerインスタンスを取得します。- protected void- postProcessContext- (Context context) Tomcat- Contextを Tomcat サーバーで使用する前に後処理します。- protected void- prepareContext- (Host host, ServletContextInitializer[] initializers) - void- setBackgroundProcessorDelay- (int delay) バックグラウンドプロセッサーの遅延を秒単位で設定します。- void- setBaseDirectory- (FileSE baseDirectory) Tomcat のベースディレクトリを設定します。- void- setContextLifecycleListeners- (CollectionSE<? extends LifecycleListener> contextLifecycleListeners) Tomcat- Contextに適用する- 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) Tomcat- Connectorに適用する- TomcatConnectorCustomizerを設定します。- void- setTomcatContextCustomizers- (CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers) Tomcat- Contextに適用する- TomcatContextCustomizerを設定します。- void- setTomcatProtocolHandlerCustomizers- (CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer) Tomcat- Connectorに適用する- TomcatProtocolHandlerCustomizerを設定します。- void- setUriEncoding- (CharsetSE uriEncoding) URL デコードに使用する文字エンコードを設定します。- void- setUseApr- (boolean useApr) APR を使用するかどうか。- クラス 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使用されるデフォルトプロトコルのクラス名。- 関連事項:
 
 
- コンストラクターの詳細- TomcatServletWebServerFactorypublic TomcatServletWebServerFactory()新しい- TomcatServletWebServerFactoryインスタンスを作成します。
- TomcatServletWebServerFactorypublic TomcatServletWebServerFactory- (int port) 指定されたポートを使用してリクエストをリッスンする新しい- TomcatServletWebServerFactoryを作成します。- パラメーター:
- port- リッスンするポート
 
- TomcatServletWebServerFactory指定されたコンテキストパスとポートで新しい- TomcatServletWebServerFactoryを作成します。- パラメーター:
- contextPath- ルートコンテキストパス
- port- リッスンするポート
 
 
- メソッドの詳細- getWebServerインターフェースからコピーされた説明:- ServletWebServerFactory完全に構成されましたが一時停止された新しい- WebServerインスタンスを取得します。クライアントは、- WebServer.start()が呼び出されるまで(- ApplicationContextが完全にリフレッシュされると発生します)、返されたサーバーに接続できません。- 次で指定:
-  インターフェース ServletWebServerFactoryのgetWebServer
- パラメーター:
- initializers- サーバーの起動時に適用される- ServletContextInitializer
- 戻り値:
-  完全に構成および開始された WebServer
- 関連事項:
 
- prepareContext
- customizeConnector
- configureContextTomcat- Contextを構成します。- パラメーター:
- context- Tomcat コンテキスト
- initializers- 適用する初期化子
 
- postProcessContext- パラメーター:
- context- Tomcat- Context
 
- getTomcatWebServer- TomcatWebServerを作成するために呼び出されるファクトリメソッド。サブクラスはこのメソッドをオーバーライドして、異なる- TomcatWebServerを返すか、Tomcat サーバーに追加処理を適用できます。- パラメーター:
- tomcat- Tomcat サーバー。
- 戻り値:
-  新しい TomcatWebServerインスタンス
 
- setResourceLoader- 次で指定:
-  インターフェース ResourceLoaderAwareのsetResourceLoader
 
- setBaseDirectoryインターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactoryTomcat のベースディレクトリを設定します。指定しない場合、一時ディレクトリが使用されます。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのsetBaseDirectory
- パラメーター:
- baseDirectory- Tomcat ベースディレクトリ
 
- getTldSkipPatternsTLD スキャンで無視する jar に一致するパターンの可変セットを返します。- 戻り値:
- TLD スキャンで無視する jar のセット
 
- setTldSkipPatternsjar に一致するパターンを設定して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。デフォルトでは、そのソースから描画されたリストになります。- パラメーター:
- patterns- TLD などをスキャンするときにスキップする jar パターン
 
- addTldSkipPatternsjar に一致するパターンを追加して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。- パラメーター:
- patterns- TLD などをスキャンするときにスキップする追加の jar パターン
 
- setProtocol- Connectorを作成するときに使用する Tomcat プロトコル。- パラメーター:
- protocol- プロトコル
- 関連事項:
 
- setEngineValves- パラメーター:
- engineValves- 設定するバルブ
 
- getEngineValves- 戻り値:
- 適用されるエンジンバルブ
 
- addEngineValvesインターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactory- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのaddEngineValves
- パラメーター:
- engineValves- 追加するバルブ
 
- setContextValves- パラメーター:
- contextValves- 設定するバルブ
 
- getContextValves- 戻り値:
- 適用されるコンテキストバルブ
- 関連事項:
 
- addContextValves- パラメーター:
- contextValves- 追加するバルブ
 
- setContextLifecycleListenerspublic void setContextLifecycleListeners- (CollectionSE<? extends LifecycleListener> contextLifecycleListeners) Tomcat- Contextに適用する- LifecycleListenerを設定します。このメソッドを呼び出すと、既存のリスナーが置き換えられます。- パラメーター:
- contextLifecycleListeners- 設定するリスナー
 
- getContextLifecycleListenersTomcat- Contextに適用される- LifecycleListenerの可変コレクションを返します。- 戻り値:
- 適用されるコンテキストライフサイクルリスナー
 
- addContextLifecycleListenersTomcat- Contextに追加する必要がある- LifecycleListenerを追加します。- パラメーター:
- contextLifecycleListeners- 追加するリスナー
 
- setTomcatContextCustomizerspublic void setTomcatContextCustomizers- (CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers) Tomcat- Contextに適用する- TomcatContextCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
- tomcatContextCustomizers- 設定するカスタマイザー
 
- getTomcatContextCustomizersTomcat- Contextに適用される- TomcatContextCustomizerの可変コレクションを返します。- 戻り値:
- 適用されるリスナー
 
- addContextCustomizersインターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactoryTomcat- Contextに追加する必要がある- TomcatContextCustomizerを追加します。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのaddContextCustomizers
- パラメーター:
- tomcatContextCustomizers- 追加するカスタマイザー
 
- setTomcatConnectorCustomizerspublic void setTomcatConnectorCustomizers- (CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) Tomcat- Connectorに適用する- TomcatConnectorCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
- tomcatConnectorCustomizers- 設定するカスタマイザー
 
- addConnectorCustomizersインターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactoryTomcat- Connectorに追加する必要がある- TomcatConnectorCustomizerを追加します。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのaddConnectorCustomizers
- パラメーター:
- tomcatConnectorCustomizers- 追加するカスタマイザー
 
- getTomcatConnectorCustomizersTomcat- Connectorに適用される- TomcatConnectorCustomizerの可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
 
- setTomcatProtocolHandlerCustomizerspublic void setTomcatProtocolHandlerCustomizers- (CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer) Tomcat- Connectorに適用する- TomcatProtocolHandlerCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
- tomcatProtocolHandlerCustomizer- 設定するカスタマイザー
- 導入:
- 2.2.0
 
- addProtocolHandlerCustomizerspublic void addProtocolHandlerCustomizers- (TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers) Tomcat- Connectorに追加する必要がある- TomcatProtocolHandlerCustomizerを追加します。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのaddProtocolHandlerCustomizers
- パラメーター:
- tomcatProtocolHandlerCustomizers- 追加するカスタマイザー
- 導入:
- 2.2.0
 
- getTomcatProtocolHandlerCustomizersTomcat- Connectorに適用される- TomcatProtocolHandlerCustomizerの可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
- 導入:
- 2.2.0
 
- addAdditionalTomcatConnectorsデフォルトのコネクターに加えて- Connectorを追加します。SSL または AJP の場合。- Connector customizersは、この方法で追加されたコネクターには適用されません。- パラメーター:
- connectors- 追加するコネクター
 
- getAdditionalTomcatConnectorsTomcat に追加される- Connectorの可変コレクションを返します。- 戻り値:
- additionalTomcatConnectors
 
- setUriEncodingインターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactoryURL デコードに使用する文字エンコードを設定します。指定しない場合、"UTF-8" が使用されます。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのsetUriEncoding
- パラメーター:
- uriEncoding- 設定する URI エンコーディング
 
- getUriEncodingURL デコードに使用する文字エンコードを返します。- 戻り値:
- URI エンコーディング
 
- setBackgroundProcessorDelaypublic void setBackgroundProcessorDelay- (int delay) インターフェースからコピーされた説明:- ConfigurableTomcatWebServerFactoryバックグラウンドプロセッサーの遅延を秒単位で設定します。- 次で指定:
-  インターフェース ConfigurableTomcatWebServerFactoryのsetBackgroundProcessorDelay
- パラメーター:
- delay- 秒単位の遅延
 
- setDisableMBeanRegistrypublic void setDisableMBeanRegistry- (boolean disableMBeanRegistry) サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。- パラメーター:
- disableMBeanRegistry- MBean レジストリを無効にするかどうか
- 導入:
- 2.2.0
 
- setUseAprpublic void setUseApr- (boolean useApr) APR を使用するかどうか。- パラメーター:
- useApr- APR を使用するかどうか
- 導入:
- 3.4.4