クラス UndertowServletWebServerFactory
java.lang.ObjectSE
org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory
- 実装されているすべてのインターフェース:
Aware、ConfigurableUndertowWebServerFactory、ConfigurableWebServerFactory、ErrorPageRegistry、WebServerFactory、ConfigurableServletWebServerFactory、ServletWebServerFactory、WebListenerRegistry、ResourceLoaderAware
public class UndertowServletWebServerFactory
extends AbstractServletWebServerFactory
implements ConfigurableUndertowWebServerFactory, ResourceLoaderAware
UndertowServletWebServer の作成に使用できる ServletWebServerFactory。特に明示的に構成されていない限り、ファクトリはポート 8080 で HTTP リクエストを listen するサーバーを作成します。
- 導入:
- 2.0.0
- 作成者:
- Ivan Sopov, Andy Wilkinson, Marcos Barbero, Edd ú Mel é ndez, Scott Frederick
- 関連事項:
フィールドのサマリー
クラス org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory から継承されたフィールド
loggerコンストラクターの概要
コンストラクターコンストラクター説明新しいUndertowServletWebServerFactoryインスタンスを作成します。UndertowServletWebServerFactory(int port) 指定されたポートを使用してリクエストをリッスンする新しいUndertowServletWebServerFactoryを作成します。UndertowServletWebServerFactory(StringSE contextPath, int port) 指定されたコンテキストパスとポートで新しいUndertowServletWebServerFactoryを作成します。メソッドのサマリー
修飾子と型メソッド説明voidaddBuilderCustomizers(UndertowBuilderCustomizer... customizers) UndertowUndertow.Builderをカスタマイズするために使用する必要があるUndertowBuilderCustomizerを追加します。voidaddDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers) UndertowDeploymentInfoをカスタマイズするために使用する必要があるUndertowDeploymentInfoCustomizerを追加します。UndertowUndertow.Builderに適用されるUndertowBuilderCustomizerの可変コレクションを返します。UndertowDeploymentInfoに適用されるUndertowDeploymentInfoCustomizerの可変コレクションを返します。protected UndertowServletWebServergetUndertowWebServer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, int port) UndertowServletWebServerを作成するために呼び出されるファクトリメソッド。getWebServer(ServletContextInitializer... initializers) 完全に構成済みで一時停止された新しいWebServerインスタンスを取得します。booleanbooleanフィルターを先行初期化する必要がある場合に戻ります。booleanリクエストパスを転送時に保持する必要があるかどうかを返します。protected final booleanvoidsetAccessLogDirectory(FileSE accessLogDirectory) アクセスログディレクトリを設定します。voidsetAccessLogEnabled(boolean accessLogEnabled) アクセスログを有効にするかどうかを設定します。voidsetAccessLogPattern(StringSE accessLogPattern) アクセスログパターンを設定します。voidsetAccessLogPrefix(StringSE accessLogPrefix) アクセスログのプレフィックスを設定します。voidsetAccessLogRotate(boolean accessLogRotate) アクセスログのローテーションを有効にするかどうかを設定します。voidsetAccessLogSuffix(StringSE accessLogSuffix) アクセスログのサフィックスを設定します。voidsetBufferSize(IntegerSE bufferSize) バッファサイズを設定します。voidsetBuilderCustomizers(CollectionSE<? extends UndertowBuilderCustomizer> customizers) UndertowUndertow.Builderに適用する必要があるUndertowBuilderCustomizerを設定します。voidsetDeploymentInfoCustomizers(CollectionSE<? extends UndertowDeploymentInfoCustomizer> customizers) UndertowDeploymentInfoに適用する必要があるUndertowDeploymentInfoCustomizerを設定します。voidsetEagerFilterInit(boolean eagerFilterInit) フィルターを先行初期化するかどうかを設定します。voidsetIoThreads(IntegerSE ioThreads) IO スレッドの数を設定します。voidsetPreservePathOnForward(boolean preservePathOnForward) リクエストパスを転送時に保持するかどうかを設定します。voidsetResourceLoader(ResourceLoader resourceLoader) voidsetUseDirectBuffers(BooleanSE directBuffers) ダイレクトバッファを使用するかどうかを設定します。voidsetUseForwardHeaders(boolean useForwardHeaders) x-forward-* ヘッダーを処理するかどうかを設定します。voidsetWorkerThreads(IntegerSE workerThreads) ワーカースレッドの数を設定します。クラス 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
コンストラクターの詳細
UndertowServletWebServerFactory
public UndertowServletWebServerFactory()新しいUndertowServletWebServerFactoryインスタンスを作成します。UndertowServletWebServerFactory
public UndertowServletWebServerFactory(int port) 指定されたポートを使用してリクエストをリッスンする新しいUndertowServletWebServerFactoryを作成します。- パラメーター:
port- リッスンするポート
UndertowServletWebServerFactory
指定されたコンテキストパスとポートで新しいUndertowServletWebServerFactoryを作成します。- パラメーター:
contextPath- ルートコンテキストパスport- リッスンするポート
メソッドの詳細
setBuilderCustomizers
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryUndertowUndertow.Builderに適用する必要があるUndertowBuilderCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetBuilderCustomizers - パラメーター:
customizers- 設定するカスタマイザー
addBuilderCustomizers
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryUndertowUndertow.Builderをカスタマイズするために使用する必要があるUndertowBuilderCustomizerを追加します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのaddBuilderCustomizers - パラメーター:
customizers- 追加するカスタマイザー
getBuilderCustomizers
UndertowUndertow.Builderに適用されるUndertowBuilderCustomizerの可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
setBufferSize
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryバッファサイズを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetBufferSize - パラメーター:
bufferSize- バッファーサイズ
setIoThreads
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryIO スレッドの数を設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetIoThreads - パラメーター:
ioThreads- IO スレッドの数
setWorkerThreads
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryワーカースレッドの数を設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetWorkerThreads - パラメーター:
workerThreads- ワーカースレッドの数
setUseDirectBuffers
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryダイレクトバッファを使用するかどうかを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetUseDirectBuffers - パラメーター:
directBuffers- 直接バッファを使用するかどうか
setAccessLogDirectory
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryアクセスログディレクトリを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetAccessLogDirectory - パラメーター:
accessLogDirectory- アクセスログディレクトリ
setAccessLogPattern
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryアクセスログパターンを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetAccessLogPattern - パラメーター:
accessLogPattern- アクセスログパターン
setAccessLogPrefix
インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryアクセスログのプレフィックスを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetAccessLogPrefix - パラメーター:
accessLogPrefix- ログプレフィックス
getAccessLogPrefix
setAccessLogSuffix
インターフェースからコピーされた説明: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- アクセスログのローテーションが有効かどうか
setUseForwardHeaders
public void setUseForwardHeaders(boolean useForwardHeaders) インターフェースからコピーされた説明:ConfigurableUndertowWebServerFactoryx-forward-* ヘッダーを処理するかどうかを設定します。- 次で指定:
- インターフェース
ConfigurableUndertowWebServerFactoryのsetUseForwardHeaders - パラメーター:
useForwardHeaders- x-forward ヘッダーを使用する必要がある場合
isUseForwardHeaders
protected final boolean isUseForwardHeaders()setDeploymentInfoCustomizers
public void setDeploymentInfoCustomizers(CollectionSE<? extends UndertowDeploymentInfoCustomizer> customizers) UndertowDeploymentInfoに適用する必要があるUndertowDeploymentInfoCustomizerを設定します。このメソッドを呼び出すと、既存のカスタマイザーが置き換えられます。- パラメーター:
customizers- 設定するカスタマイザー
addDeploymentInfoCustomizers
UndertowDeploymentInfoをカスタマイズするために使用する必要があるUndertowDeploymentInfoCustomizerを追加します。- パラメーター:
customizers- 追加するカスタマイザー
getDeploymentInfoCustomizers
UndertowDeploymentInfoに適用されるUndertowDeploymentInfoCustomizerの可変コレクションを返します。- 戻り値:
- 適用されるカスタマイザー
setResourceLoader
- 次で指定:
- インターフェース
ResourceLoaderAwareのsetResourceLoader
isEagerFilterInit
public boolean isEagerFilterInit()フィルターを先行初期化する必要がある場合に戻ります。- 戻り値:
- フィルターが先行初期化されている場合は
true、それ以外の場合はfalse。 - 導入:
- 2.4.0
setEagerFilterInit
public void setEagerFilterInit(boolean eagerFilterInit) フィルターを先行初期化するかどうかを設定します。- パラメーター:
eagerFilterInit- フィルターが先行初期化されている場合はtrue、それ以外の場合はfalse。- 導入:
- 2.4.0
isPreservePathOnForward
public boolean isPreservePathOnForward()リクエストパスを転送時に保持する必要があるかどうかを返します。- 戻り値:
- リクエストの転送時にパスを保持する必要がある場合は
true、それ以外の場合はfalse。 - 導入:
- 2.4.0
setPreservePathOnForward
public void setPreservePathOnForward(boolean preservePathOnForward) リクエストパスを転送時に保持するかどうかを設定します。- パラメーター:
preservePathOnForward- リクエストの転送時にパスを保持する必要がある場合はtrue、それ以外の場合はfalse。- 導入:
- 2.4.0
getWebServer
インターフェースからコピーされた説明:ServletWebServerFactory完全に構成されましたが一時停止された新しいWebServerインスタンスを取得します。クライアントは、WebServer.start()が呼び出されるまで(ApplicationContextが完全にリフレッシュされると発生します)、返されたサーバーに接続できません。- 次で指定:
- インターフェース
ServletWebServerFactoryのgetWebServer - パラメーター:
initializers- サーバーの起動時に適用されるServletContextInitializer- 戻り値:
- 完全に構成および開始された
WebServer - 関連事項:
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インスタンス