クラス 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を作成します。メソッドのサマリー
修飾子と型メソッド説明voidaddAdditionalTomcatConnectors(Connector... connectors) デフォルトのコネクターに加えてConnectorを追加します。voidaddConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers) TomcatConnectorに追加する必要があるTomcatConnectorCustomizerを追加します。voidaddContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers) TomcatContextに追加する必要があるTomcatContextCustomizerを追加します。voidaddContextLifecycleListeners(LifecycleListener... contextLifecycleListeners) TomcatContextに追加する必要があるLifecycleListenerを追加します。voidaddContextValves(Valve... contextValves) voidaddEngineValves(Valve... engineValves) voidaddProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers) TomcatConnectorに追加する必要があるTomcatProtocolHandlerCustomizerを追加します。voidaddTldSkipPatterns(StringSE... patterns) jar に一致するパターンを追加して、TLD スキャンで無視します。protected voidconfigureContext(Context context, ServletContextInitializer[] initializers) TomcatContextを構成します。protected voidcustomizeConnector(Connector connector) Tomcat に追加されるConnectorの可変コレクションを返します。TomcatContextに適用されるLifecycleListenerの可変コレクションを返します。TLD スキャンで無視する jar に一致するパターンの可変セットを返します。TomcatConnectorに適用されるTomcatConnectorCustomizerの可変コレクションを返します。TomcatContextに適用されるTomcatContextCustomizerの可変コレクションを返します。TomcatConnectorに適用されるTomcatProtocolHandlerCustomizerの可変コレクションを返します。protected TomcatWebServergetTomcatWebServer(Tomcat tomcat) TomcatWebServerを作成するために呼び出されるファクトリメソッド。URL デコードに使用する文字エンコードを返します。getWebServer(ServletContextInitializer... initializers) 完全に構成済みで一時停止された新しいWebServerインスタンスを取得します。protected voidpostProcessContext(Context context) TomcatContextを Tomcat サーバーで使用する前に後処理します。protected voidprepareContext(Host host, ServletContextInitializer[] initializers) voidsetBackgroundProcessorDelay(int delay) バックグラウンドプロセッサーの遅延を秒単位で設定します。voidsetBaseDirectory(FileSE baseDirectory) Tomcat のベースディレクトリを設定します。voidsetContextLifecycleListeners(CollectionSE<? extends LifecycleListener> contextLifecycleListeners) TomcatContextに適用するLifecycleListenerを設定します。voidsetContextValves(CollectionSE<? extends Valve> contextValves) voidsetDisableMBeanRegistry(boolean disableMBeanRegistry) サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。voidsetEngineValves(CollectionSE<? extends Valve> engineValves) voidsetProtocol(StringSE protocol) Connectorを作成するときに使用する Tomcat プロトコル。voidsetResourceLoader(ResourceLoader resourceLoader) voidsetTldSkipPatterns(CollectionSE<StringSE> patterns) jar に一致するパターンを設定して、TLD スキャンで無視します。voidsetTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) TomcatConnectorに適用するTomcatConnectorCustomizerを設定します。voidsetTomcatContextCustomizers(CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers) TomcatContextに適用するTomcatContextCustomizerを設定します。voidsetTomcatProtocolHandlerCustomizers(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer) TomcatConnectorに適用するTomcatProtocolHandlerCustomizerを設定します。voidsetUriEncoding(CharsetSE uriEncoding) URL デコードに使用する文字エンコードを設定します。voidsetUseApr(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
使用されるデフォルトプロトコルのクラス名。- 関連事項:
コンストラクターの詳細
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
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactoryTomcat のベースディレクトリを設定します。指定しない場合、一時ディレクトリが使用されます。- 次で指定:
- インターフェース
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
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactoryTomcatContextに追加する必要があるTomcatContextCustomizerを追加します。- 次で指定:
- インターフェース
ConfigurableTomcatWebServerFactoryのaddContextCustomizers - パラメーター:
tomcatContextCustomizers- 追加するカスタマイザー
setTomcatConnectorCustomizers
public void setTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers) TomcatConnectorに適用するTomcatConnectorCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
tomcatConnectorCustomizers- 設定するカスタマイザー
addConnectorCustomizers
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactoryTomcatConnectorに追加する必要がある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
インターフェースからコピーされた説明:ConfigurableTomcatWebServerFactoryURL デコードに使用する文字エンコードを設定します。指定しない場合、"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
setUseApr
public void setUseApr(boolean useApr) APR を使用するかどうか。- パラメーター:
useApr- APR を使用するかどうか- 導入:
- 3.4.4