UndertowServletWebServerFactory (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.undertow.UndertowServletWebServerFactory

実装されているすべてのインターフェース:
org.springframework.beans.factory.Aware, ConfigurableUndertowWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory, org.springframework.context.ResourceLoaderAware
```
public class UndertowServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableUndertowWebServerFactory, org.springframework.context.ResourceLoaderAware
```
UndertowServletWebServer の作成に使用できる ServletWebServerFactory。
特に明示的に構成されていない限り、ファクトリはポート 8080 で HTTP リクエストを listen するサーバーを作成します。
導入:
2.0.0
作成者:
Ivan Sopov, Andy Wilkinson, Marcos Barbero, Edd ú Mel é ndez
関連事項:
UndertowServletWebServer

フィールドのサマリー
- クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたフィールド
  logger

コンストラクターの概要

コンストラクター
コンストラクターと説明
`UndertowServletWebServerFactory()` 新しい `UndertowServletWebServerFactory` インスタンスを作成します。
`UndertowServletWebServerFactory(int port)` 指定されたポートを使用してリクエストをリッスンする新しい `UndertowServletWebServerFactory` を作成します。
`UndertowServletWebServerFactory(StringSE contextPath, int port)` 指定されたコンテキストパスとポートで新しい `UndertowServletWebServerFactory` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addBuilderCustomizers(UndertowBuilderCustomizer... customizers)` Undertow `Undertow.Builder` をカスタマイズするために使用する必要がある `UndertowBuilderCustomizer` を追加します。
`void`	`addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)` Undertow `DeploymentInfo` をカスタマイズするために使用する必要がある `UndertowDeploymentInfoCustomizer` を追加します。
`StringSE`	`getAccessLogPrefix()`
`CollectionSE<UndertowBuilderCustomizer>`	`getBuilderCustomizers()` Undertow `Undertow.Builder` に適用される `UndertowBuilderCustomizer` の可変コレクションを返します。
`CollectionSE<UndertowDeploymentInfoCustomizer>`	`getDeploymentInfoCustomizers()` Undertow `DeploymentInfo` に適用される `UndertowDeploymentInfoCustomizer` の可変コレクションを返します。
`protected UndertowServletWebServer`	`getUndertowWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, int port)` `UndertowServletWebServer` を作成するために呼び出されるファクトリメソッド。
`WebServer`	`getWebServer(ServletContextInitializer... initializers)` 完全に構成済みで一時停止された新しい `WebServer` インスタンスを取得します。
`boolean`	`isAccessLogEnabled()`
`boolean`	`isEagerInitFilters()` フィルターを積極的に初期化する必要がある場合に戻ります。
`protected boolean`	`isUseForwardHeaders()`
`void`	`setAccessLogDirectory(FileSE accessLogDirectory)` アクセスログディレクトリを設定します。
`void`	`setAccessLogEnabled(boolean accessLogEnabled)` アクセスログを有効にするかどうかを設定します。
`void`	`setAccessLogPattern(StringSE accessLogPattern)` アクセスログパターンを設定します。
`void`	`setAccessLogPrefix(StringSE accessLogPrefix)` アクセスログのプレフィックスを設定します。
`void`	`setAccessLogRotate(boolean accessLogRotate)` アクセスログのローテーションを有効にするかどうかを設定します。
`void`	`setAccessLogSuffix(StringSE accessLogSuffix)` アクセスログのサフィックスを設定します。
`void`	`setBufferSize(IntegerSE bufferSize)` バッファサイズを設定します。
`void`	`setBuilderCustomizers(CollectionSE<? extends UndertowBuilderCustomizer> customizers)` Undertow `Undertow.Builder` に適用する必要がある `UndertowBuilderCustomizer` を設定します。
`void`	`setDeploymentInfoCustomizers(CollectionSE<? extends UndertowDeploymentInfoCustomizer> customizers)` Undertow `DeploymentInfo` に適用する必要がある `UndertowDeploymentInfoCustomizer` を設定します。
`void`	`setEagerInitFilters(boolean eagerInitFilters)` フィルターを積極的に初期化するかどうかを設定します。
`void`	`setIoThreads(IntegerSE ioThreads)` IO スレッドの数を設定します。
`void`	`setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)`
`void`	`setUseDirectBuffers(BooleanSE directBuffers)` ダイレクトバッファを使用するかどうかを設定します。
`void`	`setUseForwardHeaders(boolean useForwardHeaders)` x-forward-* ヘッダーを処理するかどうかを設定します。
`void`	`setWorkerThreads(IntegerSE workerThreads)` ワーカースレッドの数を設定します。

クラス 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

- コンストラクターの詳細
  - UndertowServletWebServerFactory
```
public UndertowServletWebServerFactory()
```
    新しい UndertowServletWebServerFactory インスタンスを作成します。
  - UndertowServletWebServerFactory
```
public UndertowServletWebServerFactory(int port)
```
    指定されたポートを使用してリクエストをリッスンする新しい UndertowServletWebServerFactory を作成します。
    パラメーター:
    port - リッスンするポート
  - UndertowServletWebServerFactory
```
public UndertowServletWebServerFactory(StringSE contextPath,
                                       int port)
```
    指定されたコンテキストパスとポートで新しい UndertowServletWebServerFactory を作成します。
    パラメーター:
    contextPath - ルートコンテキストパス
    port - リッスンするポート
- メソッドの詳細
  - setBuilderCustomizers
```
public void setBuilderCustomizers(CollectionSE<? extends UndertowBuilderCustomizer> customizers)
```
    Undertow Undertow.Builder に適用する必要がある UndertowBuilderCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    customizers - 設定するカスタマイザー
  - getBuilderCustomizers
```
public CollectionSE<UndertowBuilderCustomizer> getBuilderCustomizers()
```
    Undertow Undertow.Builder に適用される UndertowBuilderCustomizer の可変コレクションを返します。
    戻り値:
    適用されるカスタマイザー
  - addBuilderCustomizers
```
public void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    Undertow Undertow.Builder をカスタマイズするために使用する必要がある UndertowBuilderCustomizer を追加します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の addBuilderCustomizers
    パラメーター:
    customizers - 追加するカスタマイザー
  - setDeploymentInfoCustomizers
```
public void setDeploymentInfoCustomizers(CollectionSE<? extends UndertowDeploymentInfoCustomizer> customizers)
```
    Undertow DeploymentInfo に適用する必要がある UndertowDeploymentInfoCustomizer を設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。
    パラメーター:
    customizers - 設定するカスタマイザー
  - getDeploymentInfoCustomizers
```
public CollectionSE<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers()
```
    Undertow DeploymentInfo に適用される UndertowDeploymentInfoCustomizer の可変コレクションを返します。
    戻り値:
    適用されるカスタマイザー
  - addDeploymentInfoCustomizers
```
public void addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)
```
    Undertow DeploymentInfo をカスタマイズするために使用する必要がある UndertowDeploymentInfoCustomizer を追加します。
    パラメーター:
    customizers - 追加するカスタマイザー
  - getWebServer
```
public WebServer getWebServer(ServletContextInitializer... initializers)
```
    インターフェースからコピーされた説明: ServletWebServerFactory
    完全に構成されましたが一時停止された新しい WebServer インスタンスを取得します。クライアントは、WebServer.start() が呼び出されるまで（ApplicationContext が完全にリフレッシュされると発生します）、返されたサーバーに接続できません。
    次で指定:
    インターフェース ServletWebServerFactory の getWebServer
    パラメーター:
    initializers - サーバーの起動時に適用される ServletContextInitializer
    戻り値:
    完全に構成および開始された WebServer
    関連事項:
    WebServer.stop()
  - getUndertowWebServer
```
protected UndertowServletWebServer getUndertowWebServer(io.undertow.Undertow.Builder builder,
                                                        io.undertow.servlet.api.DeploymentManager manager,
                                                        int port)
```
    UndertowServletWebServer を作成するために呼び出されたファクトリメソッド。サブクラスは、このメソッドをオーバーライドして、別の UndertowServletWebServer を返すか、Undertow のブートストラップに使用される Undertow.Builder および DeploymentManager に追加の処理を適用できます。
    パラメーター:
    builder - ビルダー
    manager - デプロイマネージャー
    port - Undertow がリッスンする必要のあるポート
    戻り値:
    新しい UndertowServletWebServer インスタンス
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    次で指定:
    インターフェース org.springframework.context.ResourceLoaderAware の setResourceLoader
  - setBufferSize
```
public void setBufferSize(IntegerSE bufferSize)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    バッファサイズを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setBufferSize
    パラメーター:
    bufferSize - バッファーサイズ
  - setIoThreads
```
public void setIoThreads(IntegerSE ioThreads)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    IO スレッドの数を設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setIoThreads
    パラメーター:
    ioThreads - IO スレッドの数
  - setWorkerThreads
```
public void setWorkerThreads(IntegerSE workerThreads)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    ワーカースレッドの数を設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setWorkerThreads
    パラメーター:
    workerThreads - ワーカースレッドの数
  - setUseDirectBuffers
```
public void setUseDirectBuffers(BooleanSE directBuffers)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    ダイレクトバッファを使用するかどうかを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setUseDirectBuffers
    パラメーター:
    directBuffers - 直接バッファを使用するかどうか
  - setAccessLogDirectory
```
public void setAccessLogDirectory(FileSE accessLogDirectory)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログディレクトリを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogDirectory
    パラメーター:
    accessLogDirectory - アクセスログディレクトリ
  - setAccessLogPattern
```
public void setAccessLogPattern(StringSE accessLogPattern)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログパターンを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogPattern
    パラメーター:
    accessLogPattern - アクセスログパターン
  - getAccessLogPrefix
```
public StringSE getAccessLogPrefix()
```
  - setAccessLogPrefix
```
public void setAccessLogPrefix(StringSE accessLogPrefix)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログのプレフィックスを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogPrefix
    パラメーター:
    accessLogPrefix - ログプレフィックス
  - setAccessLogSuffix
```
public void setAccessLogSuffix(StringSE accessLogSuffix)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログのサフィックスを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogSuffix
    パラメーター:
    accessLogSuffix - アクセスログの接尾辞
  - setAccessLogEnabled
```
public void setAccessLogEnabled(boolean accessLogEnabled)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログを有効にするかどうかを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogEnabled
    パラメーター:
    accessLogEnabled - アクセスログが有効かどうか
  - isAccessLogEnabled
```
public boolean isAccessLogEnabled()
```
  - setAccessLogRotate
```
public void setAccessLogRotate(boolean accessLogRotate)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    アクセスログのローテーションを有効にするかどうかを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setAccessLogRotate
    パラメーター:
    accessLogRotate - アクセスログのローテーションが有効かどうか
  - isUseForwardHeaders
```
protected final boolean isUseForwardHeaders()
```
  - setUseForwardHeaders
```
public void setUseForwardHeaders(boolean useForwardHeaders)
```
    インターフェースからコピーされた説明: ConfigurableUndertowWebServerFactory
    x-forward-* ヘッダーを処理するかどうかを設定します。
    次で指定:
    インターフェース ConfigurableUndertowWebServerFactory の setUseForwardHeaders
    パラメーター:
    useForwardHeaders - x-forward ヘッダーを使用する必要がある場合
  - isEagerInitFilters
```
public boolean isEagerInitFilters()
```
    フィルターを積極的に初期化する必要がある場合に戻ります。
    戻り値:
    フィルターが積極的に初期化される場合は true、そうでない場合は false
    導入:
    2.0.0
  - setEagerInitFilters
```
public void setEagerInitFilters(boolean eagerInitFilters)
```
    フィルターを積極的に初期化するかどうかを設定します。
    パラメーター:
    eagerInitFilters - フィルターが先行初期化されている場合は true、それ以外の場合は false。
    導入:
    2.0.0

クラス UndertowServletWebServerFactory

フィールドのサマリー

クラス 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 から継承されたメソッド

コンストラクターの詳細

UndertowServletWebServerFactory

UndertowServletWebServerFactory

UndertowServletWebServerFactory

メソッドの詳細

setBuilderCustomizers

getBuilderCustomizers

addBuilderCustomizers

setDeploymentInfoCustomizers

getDeploymentInfoCustomizers

addDeploymentInfoCustomizers

getWebServer

getUndertowWebServer

setResourceLoader

setBufferSize

setIoThreads

setWorkerThreads

setUseDirectBuffers

setAccessLogDirectory

setAccessLogPattern

getAccessLogPrefix

setAccessLogPrefix

setAccessLogSuffix

setAccessLogEnabled

isAccessLogEnabled

setAccessLogRotate

isUseForwardHeaders

setUseForwardHeaders

isEagerInitFilters

setEagerInitFilters