TomcatReactiveWebServerFactory (Spring Boot Docs 2.2.1.RELEASE API)

java.lang.ObjectSE
- 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
```
TomcatWebServer の作成に使用できる ReactiveWebServerFactory。
導入:
2.0.0
作成者:
Brian Clozel, HaiTao Zhang

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

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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`TomcatReactiveWebServerFactory()` 新しい `TomcatServletWebServerFactory` インスタンスを作成します。
`TomcatReactiveWebServerFactory(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`	`addEngineValves(Valve... engineValves)` Tomcat `Engine` に適用する必要がある `Valve` を追加します。
`void`	`addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)` Tomcat `Connector` に追加する必要がある `TomcatProtocolHandlerCustomizer` を追加します。
`protected void`	`configureContext(Context context)` Tomcat `Context` を構成します。
`protected void`	`customizeConnector(Connector connector)`
`ListSE<Connector>`	`getAdditionalTomcatConnectors()` Tomcat に追加される `Connector` の可変コレクションを返します。
`CollectionSE<LifecycleListener>`	`getContextLifecycleListeners()` Tomcat `Context` に適用される `LifecycleListener` の可変コレクションを返します。
`ListSE<Valve>`	`getEngineValves()` Tomcat `Engine` に適用される `Valve` の可変コレクションを返します。
`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(org.springframework.http.server.reactive.HttpHandler httpHandler)` 完全に構成済みで一時停止された新しい `WebServer` インスタンスを取得します。
`protected void`	`prepareContext(Host host, org.springframework.http.server.reactive.TomcatHttpHandlerAdapter servlet)`
`void`	`setBackgroundProcessorDelay(int delay)` バックグラウンドプロセッサーの遅延を秒単位で設定します。
`void`	`setBaseDirectory(FileSE baseDirectory)` Tomcat のベースディレクトリを設定します。
`void`	`setContextLifecycleListeners(CollectionSE<? extends LifecycleListener> contextLifecycleListeners)` Tomcat `Context` に適用する `LifecycleListener` を設定します。
`void`	`setDisableMBeanRegistry(boolean disableMBeanRegistry)` サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。
`void`	`setProtocol(StringSE protocol)` `Connector` を作成するときに使用する Tomcat プロトコル。
`void`	`setTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)` Tomcat `Connector` に適用する `TomcatConnectorCustomizer` を設定します。
`void`	`setTomcatContextCustomizers(CollectionSE<? extends TomcatContextCustomizer> tomcatContextCustomizers)` Tomcat `Context` に適用する `TomcatContextCustomizer` を設定します。
`void`	`setTomcatProtocolHandlerCustomizers(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizers)` Tomcat `Connector` に適用する `TomcatProtocolHandlerCustomizer` を設定します。
`void`	`setUriEncoding(CharsetSE uriEncoding)` URL デコードに使用する文字エンコードを設定します。

クラス 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
```
    使用されるデフォルトプロトコルのクラス名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - TomcatReactiveWebServerFactory
```
public TomcatReactiveWebServerFactory()
```
    新しい TomcatServletWebServerFactory インスタンスを作成します。
  - TomcatReactiveWebServerFactory
```
public TomcatReactiveWebServerFactory(int port)
```
    指定されたポートを使用してリクエストをリッスンする新しい TomcatServletWebServerFactory を作成します。
    パラメーター:
    port - リッスンするポート
- メソッドの詳細
  - getWebServer
```
public WebServer getWebServer(org.springframework.http.server.reactive.HttpHandler httpHandler)
```
    インターフェースからコピーされた説明: ReactiveWebServerFactory
    完全に構成されましたが一時停止された新しい WebServer インスタンスを取得します。クライアントは、WebServer.start() が呼び出されるまで（ApplicationContext が完全にリフレッシュされると発生します）、返されたサーバーに接続できません。
    次で指定:
    インターフェース ReactiveWebServerFactory の getWebServer
    パラメーター:
    httpHandler - リクエストの処理を担当する HTTP ハンドラー
    戻り値:
    完全に構成および開始された WebServer
    関連事項:
    WebServer.stop()
  - prepareContext
```
protected void prepareContext(Host host,
                              org.springframework.http.server.reactive.TomcatHttpHandlerAdapter servlet)
```
  - configureContext
```
protected void configureContext(Context context)
```
    Tomcat Context を構成します。
    パラメーター:
    context - Tomcat コンテキスト
  - customizeConnector
```
protected void customizeConnector(Connector connector)
```
  - setBaseDirectory
```
public void setBaseDirectory(FileSE baseDirectory)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat のベースディレクトリを設定します。指定しない場合、一時ディレクトリが使用されます。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の setBaseDirectory
    パラメーター:
    baseDirectory - Tomcat ベースディレクトリ
  - setBackgroundProcessorDelay
```
public void setBackgroundProcessorDelay(int delay)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    バックグラウンドプロセッサーの遅延を秒単位で設定します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の setBackgroundProcessorDelay
    パラメーター:
    delay - 秒単位の遅延
  - 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)
```
    Tomcat Context に追加する必要がある TomcatContextCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addContextCustomizers
    パラメーター:
    tomcatContextCustomizers - 追加するカスタマイザー
  - setTomcatConnectorCustomizers
```
public void setTomcatConnectorCustomizers(CollectionSE<? extends TomcatConnectorCustomizer> tomcatConnectorCustomizers)
```
    Tomcat Connector に適用する TomcatConnectorCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    tomcatConnectorCustomizers - 設定するカスタマイザー
  - addConnectorCustomizers
```
public void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
```
    Tomcat Connector に追加する必要がある TomcatConnectorCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addConnectorCustomizers
    パラメーター:
    tomcatConnectorCustomizers - 追加するカスタマイザー
  - getTomcatConnectorCustomizers
```
public CollectionSE<TomcatConnectorCustomizer> getTomcatConnectorCustomizers()
```
    Tomcat Connector に適用される TomcatConnectorCustomizer の可変コレクションを返します。
    戻り値:
    適用されるカスタマイザー
  - setTomcatProtocolHandlerCustomizers
```
public void setTomcatProtocolHandlerCustomizers(CollectionSE<? extends TomcatProtocolHandlerCustomizer<?>> tomcatProtocolHandlerCustomizers)
```
    Tomcat Connector に適用する TomcatProtocolHandlerCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    tomcatProtocolHandlerCustomizers - 設定するカスタマイザー
    導入:
    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 - 追加するコネクター
    導入:
    2.2.0
  - getAdditionalTomcatConnectors
```
public ListSE<Connector> getAdditionalTomcatConnectors()
```
    Tomcat に追加される Connector の可変コレクションを返します。
    戻り値:
    additionalTomcatConnectors
    導入:
    2.2.0
  - addEngineValves
```
public void addEngineValves(Valve... engineValves)
```
    インターフェースからコピーされた説明: ConfigurableTomcatWebServerFactory
    Tomcat Engine に適用する必要がある Valve を追加します。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の addEngineValves
    パラメーター:
    engineValves - 追加するバルブ
  - getEngineValves
```
public ListSE<Valve> getEngineValves()
```
    Tomcat Engine に適用される Valve の可変コレクションを返します。
    戻り値:
    適用されるエンジンバルブ
  - setUriEncoding
```
public void setUriEncoding(CharsetSE uriEncoding)
```
    URL デコードに使用する文字エンコードを設定します。指定しない場合、"UTF-8" が使用されます。
    次で指定:
    インターフェース ConfigurableTomcatWebServerFactory の setUriEncoding
    パラメーター:
    uriEncoding - 設定する URI エンコーディング
  - getUriEncoding
```
public CharsetSE getUriEncoding()
```
    URL デコードに使用する文字エンコードを返します。
    戻り値:
    URI エンコーディング
  - 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 - 追加するリスナー
  - getTomcatWebServer
```
protected TomcatWebServer getTomcatWebServer(Tomcat tomcat)
```
    TomcatWebServer を作成するために呼び出されるファクトリメソッド。サブクラスはこのメソッドをオーバーライドして、異なる TomcatWebServer を返すか、Tomcat サーバーに追加処理を適用できます。
    パラメーター:
    tomcat - Tomcat サーバー。
    戻り値:
    新しい TomcatWebServer インスタンス
  - setProtocol
```
public void setProtocol(StringSE protocol)
```
    Connector を作成するときに使用する Tomcat プロトコル。
    パラメーター:
    protocol - プロトコル
    関連事項:
    Connector.Connector(String)
  - setDisableMBeanRegistry
```
public void setDisableMBeanRegistry(boolean disableMBeanRegistry)
```
    サーバーを作成する前に、ファクトリが Tomcat の MBean レジストリを無効にするかどうかを設定します。
    パラメーター:
    disableMBeanRegistry - MBean レジストリを無効にするかどうか
    導入:
    2.2.0

クラス TomcatReactiveWebServerFactory

フィールドのサマリー

コンストラクターの概要

方法の概要

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

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

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

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

フィールドの詳細

DEFAULT_PROTOCOL

コンストラクターの詳細

TomcatReactiveWebServerFactory

TomcatReactiveWebServerFactory

メソッドの詳細

getWebServer

prepareContext

configureContext

customizeConnector

setBaseDirectory

setBackgroundProcessorDelay

setTomcatContextCustomizers

getTomcatContextCustomizers

addContextCustomizers

setTomcatConnectorCustomizers

addConnectorCustomizers

getTomcatConnectorCustomizers

setTomcatProtocolHandlerCustomizers

addProtocolHandlerCustomizers

getTomcatProtocolHandlerCustomizers

addAdditionalTomcatConnectors

getAdditionalTomcatConnectors

addEngineValves

getEngineValves

setUriEncoding

getUriEncoding

setContextLifecycleListeners

getContextLifecycleListeners

addContextLifecycleListeners

getTomcatWebServer

setProtocol

setDisableMBeanRegistry