TomcatServletWebServerFactory (Spring Boot Docs 2.2.1.RELEASE API)

java.lang.ObjectSE
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- - org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
  - - org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory

実装されているすべてのインターフェース:
org.springframework.beans.factory.Aware, ConfigurableTomcatWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, org.springframework.context.ResourceLoaderAware
```
public class TomcatServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableTomcatWebServerFactory, org.springframework.context.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
関連事項:
AbstractConfigurableWebServerFactory.setPort(int), setContextLifecycleListeners(Collection), TomcatWebServer

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE DEFAULT_PROTOCOL
使用されるデフォルトプロトコルのクラス名。
- クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたフィールド
  logger

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_PROTOCOL` 使用されるデフォルトプロトコルのクラス名。

コンストラクターの概要

コンストラクター
コンストラクターと説明
`TomcatServletWebServerFactory()` 新しい `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)` Tomcat `Context` に適用する必要がある `Valve` を追加します。
`void`	`addEngineValves(Valve... engineValves)` Tomcat `Engine` に適用する必要がある `Valve` を追加します。
`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)`
`ListSE<Connector>`	`getAdditionalTomcatConnectors()` Tomcat に追加される `Connector` の可変コレクションを返します。
`CollectionSE<LifecycleListener>`	`getContextLifecycleListeners()` Tomcat `Context` に適用される `LifecycleListener` の可変コレクションを返します。
`CollectionSE<Valve>`	`getContextValves()` Tomcat `Context` に適用される `Valve` の可変コレクションを返します。
`CollectionSE<Valve>`	`getEngineValves()` Tomcat `Engine` に適用される `Valve` の可変コレクションを返します。
`SetSE<StringSE>`	`getTldSkipPatterns()` TLD スキャンで無視する jar に一致するパターンの可変セットを返します。
`CollectionSE<TomcatConnectorCustomizer>`	`getTomcatConnectorCustomizers()` Tomcat `Connector` に適用される `TomcatConnectorCustomizer` の可変コレクションを返します。
`CollectionSE<TomcatContextCustomizer>`	`getTomcatContextCustomizers()` Tomcat `Context` に適用される `TomcatContextCustomizer` の可変コレクションを返します。
`CollectionSE<TomcatProtocolHandlerCustomizer<?>>`	`getTomcatProtocolHandlerCustomizers()` Tomcat `Connector` に適用される `TomcatProtocolHandlerCustomizer` の可変コレクションを返します。
`protected TomcatWebServer`	`getTomcatWebServer(Tomcat tomcat)` `TomcatWebServer` を作成するために呼び出されるファクトリメソッド。
`CharsetSE`	`getUriEncoding()` URL デコードに使用する文字エンコードを返します。
`WebServer`	`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)` Tomcat `Context` に適用する `Valve` を設定します。
`void`	`setDisableMBeanRegistry(boolean disableMBeanRegistry)` サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。
`void`	`setEngineValves(CollectionSE<? extends Valve> engineValves)` Tomcat `Engine` に適用する `Valve` を設定します。
`void`	`setProtocol(StringSE protocol)` `Connector` を作成するときに使用する Tomcat プロトコル。
`void`	`setResourceLoader(org.springframework.core.io.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 デコードに使用する文字エンコードを設定します。

クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたメソッド
addInitializers, getContextPath, getDisplayName, getDocumentRoot, getInitParameters, getJsp, getLocaleCharsetMappings, getMimeMappings, getSession, getUrlsOfJarsWithMetaInfResources, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir, isRegisterDefaultServlet, mergeInitializers, setContextPath, setDisplayName, setDocumentRoot, setInitializers, setInitParameters, setJsp, setLocaleCharsetMappings, setMimeMappings, setRegisterDefaultServlet, setSession, shouldRegisterJspServlet

クラス 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.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース 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 StringSE DEFAULT_PROTOCOL
```
    使用されるデフォルトプロトコルのクラス名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory()
```
    新しい TomcatServletWebServerFactory インスタンスを作成します。
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory(int port)
```
    指定されたポートを使用してリクエストをリッスンする新しい TomcatServletWebServerFactory を作成します。
    パラメーター:
    port - リッスンするポート
  - TomcatServletWebServerFactory
```
public TomcatServletWebServerFactory(StringSE contextPath,
                                     int port)
```
    指定されたコンテキストパスとポートで新しい TomcatServletWebServerFactory を作成します。
    パラメーター:
    contextPath - ルートコンテキストパス
    port - リッスンするポート
- メソッドの詳細
  - getWebServer
```
public WebServer getWebServer(ServletContextInitializer... initializers)
```
    インターフェースからコピーされた説明: ServletWebServerFactory
    完全に構成されましたが一時停止された新しい WebServer インスタンスを取得します。クライアントは、WebServer.start() が呼び出されるまで（ApplicationContext が完全にリフレッシュされると発生します）、返されたサーバーに接続できません。
    次で指定:
    インターフェース ServletWebServerFactory の getWebServer
    パラメーター:
    initializers - サーバーの起動時に適用される ServletContextInitializer
    戻り値:
    完全に構成および開始された WebServer
    関連事項:
    WebServer.stop()
  - prepareContext
```
protected void prepareContext(Host host,
                              ServletContextInitializer[] initializers)
```
  - customizeConnector
```
protected void customizeConnector(Connector connector)
```
  - configureContext
```
protected void configureContext(Context context,
                                ServletContextInitializer[] initializers)
```
    Tomcat Context を構成します。
    パラメーター:
    context - Tomcat コンテキスト
    initializers - 適用する初期化子
  - postProcessContext
```
protected void postProcessContext(Context context)
```
    Tomcat Context を Tomcat サーバーで使用する前に後処理します。サブクラスはこのメソッドをオーバーライドして、Context に追加処理を適用できます。
    パラメーター:
    context - Tomcat Context
  - getTomcatWebServer
```
protected TomcatWebServer getTomcatWebServer(Tomcat tomcat)
```
    TomcatWebServer を作成するために呼び出されるファクトリメソッド。サブクラスはこのメソッドをオーバーライドして、異なる TomcatWebServer を返すか、Tomcat サーバーに追加処理を適用できます。
    パラメーター:
    tomcat - Tomcat サーバー。
    戻り値:
    新しい TomcatWebServer インスタンス
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    次で指定:
    インターフェース org.springframework.context.ResourceLoaderAware の setResourceLoader
  - setBaseDirectory
```
public void setBaseDirectory(FileSE baseDirectory)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat のベースディレクトリを設定します。指定しない場合、一時ディレクトリが使用されます。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の setBaseDirectory
    パラメーター:
    baseDirectory - Tomcat ベースディレクトリ
  - getTldSkipPatterns
```
public SetSE<StringSE> getTldSkipPatterns()
```
    TLD スキャンで無視する jar に一致するパターンの可変セットを返します。
    戻り値:
    TLD スキャンで無視する jar のリスト
  - setTldSkipPatterns
```
public void setTldSkipPatterns(CollectionSE<StringSE> patterns)
```
    jar に一致するパターンを設定して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。デフォルトでは、そのソースから描画されたリストになります。
    パラメーター:
    patterns - TLD などをスキャンするときにスキップする jar パターン
  - addTldSkipPatterns
```
public void addTldSkipPatterns(StringSE... patterns)
```
    jar に一致するパターンを追加して、TLD スキャンで無視します。一般的な値については、Tomcat の catalina.properties を参照してください。
    パラメーター:
    patterns - TLD などをスキャンするときにスキップする追加の jar パターン
  - setProtocol
```
public void setProtocol(StringSE protocol)
```
    Connector を作成するときに使用する Tomcat プロトコル。
    パラメーター:
    protocol - プロトコル
    関連事項:
    Connector.Connector(String)
  - setEngineValves
```
public void setEngineValves(CollectionSE<? extends Valve> engineValves)
```
    Tomcat Engine に適用する Valve を設定します。このメソッドを呼び出すと、既存のバルブが置き換えられます。
    パラメーター:
    engineValves - 設定するバルブ
  - getEngineValves
```
public CollectionSE<Valve> getEngineValves()
```
    Tomcat Engine に適用される Valve の可変コレクションを返します。
    戻り値:
    適用されるエンジンバルブ
  - addEngineValves
```
public void addEngineValves(Valve... engineValves)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat Engine に適用する必要がある Valve を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addEngineValves
    パラメーター:
    engineValves - 追加するバルブ
  - setContextValves
```
public void setContextValves(CollectionSE<? extends Valve> contextValves)
```
    Tomcat Context に適用する Valve を設定します。このメソッドを呼び出すと、既存のバルブが置き換えられます。
    パラメーター:
    contextValves - 設定するバルブ
  - getContextValves
```
public CollectionSE<Valve> getContextValves()
```
    Tomcat Context に適用される Valve の可変コレクションを返します。
    戻り値:
    適用されるコンテキストバルブ
    関連事項:
    getEngineValves()
  - addContextValves
```
public void addContextValves(Valve... contextValves)
```
    Tomcat Context に適用する必要がある Valve を追加します。
    パラメーター:
    contextValves - 追加するバルブ
  - setContextLifecycleListeners
```
public void setContextLifecycleListeners(CollectionSE<? extends LifecycleListener> contextLifecycleListeners)
```
    Tomcat Context に適用する LifecycleListener を設定します。このメソッドを呼び出すと、既存のリスナーが置き換えられます。
    パラメーター:
    contextLifecycleListeners - 設定するリスナー
  - getContextLifecycleListeners
```
public CollectionSE<LifecycleListener> getContextLifecycleListeners()
```
    Tomcat Context に適用される LifecycleListener の可変コレクションを返します。
    戻り値:
    適用されるコンテキストライフサイクルリスナー
  - addContextLifecycleListeners
```
public void addContextLifecycleListeners(LifecycleListener... contextLifecycleListeners)
```
    Tomcat Context に追加する必要がある LifecycleListener を追加します。
    パラメーター:
    contextLifecycleListeners - 追加するリスナー
  - setTomcatContextCustomizers
```
public void setTomcatContextCustomizers(CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers)
```
    Tomcat Context に適用する TomcatContextCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    tomcatContextCustomizers - 設定するカスタマイザー
  - getTomcatContextCustomizers
```
public CollectionSE<TomcatContextCustomizer> getTomcatContextCustomizers()
```
    Tomcat Context に適用される TomcatContextCustomizer の可変コレクションを返します。
    戻り値:
    適用されるリスナー
  - addContextCustomizers
```
public void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat Context に追加する必要がある TomcatContextCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addContextCustomizers
    パラメーター:
    tomcatContextCustomizers - 追加するカスタマイザー
  - setTomcatConnectorCustomizers
```
public void setTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
```
    Tomcat Connector に適用する TomcatConnectorCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    tomcatConnectorCustomizers - 設定するカスタマイザー
  - addConnectorCustomizers
```
public void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat Connector に追加する必要がある TomcatConnectorCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addConnectorCustomizers
    パラメーター:
    tomcatConnectorCustomizers - 追加するカスタマイザー
  - getTomcatConnectorCustomizers
```
public CollectionSE<TomcatConnectorCustomizer> getTomcatConnectorCustomizers()
```
    Tomcat Connector に適用される TomcatConnectorCustomizer の可変コレクションを返します。
    戻り値:
    適用されるカスタマイザー
  - setTomcatProtocolHandlerCustomizers
```
public void setTomcatProtocolHandlerCustomizers(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizer)
```
    Tomcat Connector に適用する TomcatProtocolHandlerCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    tomcatProtocolHandlerCustomizer - 設定するカスタマイザー
    導入:
    2.2.0
  - addProtocolHandlerCustomizers
```
public void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)
```
    Tomcat Connector に追加する必要がある TomcatProtocolHandlerCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addProtocolHandlerCustomizers
    パラメーター:
    tomcatProtocolHandlerCustomizers - 追加するカスタマイザー
    導入:
    2.2.0
  - getTomcatProtocolHandlerCustomizers
```
public CollectionSE<TomcatProtocolHandlerCustomizer<?>> getTomcatProtocolHandlerCustomizers()
```
    Tomcat Connector に適用される TomcatProtocolHandlerCustomizer の可変コレクションを返します。
    戻り値:
    適用されるカスタマイザー
    導入:
    2.2.0
  - addAdditionalTomcatConnectors
```
public void addAdditionalTomcatConnectors(Connector... connectors)
```
    デフォルトのコネクターに加えて Connector を追加します。SSL または AJP の場合
    パラメーター:
    connectors - 追加するコネクター
  - getAdditionalTomcatConnectors
```
public ListSE<Connector> getAdditionalTomcatConnectors()
```
    Tomcat に追加される Connector の可変コレクションを返します。
    戻り値:
    additionalTomcatConnectors
  - setUriEncoding
```
public void setUriEncoding(CharsetSE uriEncoding)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    URL デコードに使用する文字エンコードを設定します。指定しない場合、"UTF-8" が使用されます。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の setUriEncoding
    パラメーター:
    uriEncoding - 設定する URI エンコーディング
  - getUriEncoding
```
public CharsetSE 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

クラス TomcatServletWebServerFactory

フィールドのサマリー

クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたメソッド

クラス org.springframework.boot.web.server.AbstractConfigurableWebServerFactory から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.boot.web.server.ConfigurableWebServerFactory から継承されたメソッド

インターフェース org.springframework.boot.web.server.ErrorPageRegistry から継承されたメソッド

フィールドの詳細

DEFAULT_PROTOCOL

コンストラクターの詳細

TomcatServletWebServerFactory

TomcatServletWebServerFactory

TomcatServletWebServerFactory

メソッドの詳細

getWebServer

prepareContext

customizeConnector

configureContext

postProcessContext

getTomcatWebServer

setResourceLoader

setBaseDirectory

getTldSkipPatterns

setTldSkipPatterns

addTldSkipPatterns

setProtocol

setEngineValves

getEngineValves

addEngineValves

setContextValves

getContextValves

addContextValves

setContextLifecycleListeners

getContextLifecycleListeners

addContextLifecycleListeners

setTomcatContextCustomizers

getTomcatContextCustomizers

addContextCustomizers

setTomcatConnectorCustomizers

addConnectorCustomizers

getTomcatConnectorCustomizers

setTomcatProtocolHandlerCustomizers

addProtocolHandlerCustomizers

getTomcatProtocolHandlerCustomizers

addAdditionalTomcatConnectors

getAdditionalTomcatConnectors

setUriEncoding

getUriEncoding

setBackgroundProcessorDelay

setDisableMBeanRegistry