クラス AbstractServletWebServerFactory
java.lang.ObjectSE
org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory
- 実装されているすべてのインターフェース:
ConfigurableWebServerFactory、ErrorPageRegistry、WebServerFactory、ConfigurableServletWebServerFactory、ServletWebServerFactory、WebListenerRegistry
- 既知の直属サブクラス
JettyServletWebServerFactory、TomcatServletWebServerFactory、UndertowServletWebServerFactory
public abstract class AbstractServletWebServerFactory
extends AbstractConfigurableWebServerFactory
implements ConfigurableServletWebServerFactory
ConfigurableServletWebServerFactory 実装の抽象基本クラス。- 導入:
- 2.0.0
- 作成者:
- Phillip Webb, Dave Syer, Andy Wilkinson, Stephane Nicoll, Ivan Sopov, Edd ú Mel é ndez, Brian Clozel
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターコンストラクター説明新しいAbstractServletWebServerFactoryインスタンスを作成します。AbstractServletWebServerFactory(int port) 指定されたポートで新しいAbstractServletWebServerFactoryインスタンスを作成します。AbstractServletWebServerFactory(StringSE contextPath, int port) 指定したコンテキストパスとポートを使用して、新しいAbstractServletWebServerFactoryインスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明voidaddCookieSameSiteSuppliers(CookieSameSiteSupplier... cookieSameSiteSuppliers) 追加された Cookie のCookie.SameSite属性を取得するために使用する必要があるものにCookieSameSiteSuppliersを追加します。voidaddInitializers(ServletContextInitializer... initializers) ServletWebServerFactory.getWebServer(ServletContextInitializer...)パラメーターに加えて、適用する必要があるものにServletContextInitializerを追加します。voidaddMimeMappings(MimeMappings mimeMappings) MIME 型 マッピングを追加します。voidaddWebListeners(StringSE... webListenerClassNames) サーブレットコンテナーに登録される Web リスナーを追加します。Web サーバーのコンテキストパスを返します。静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートを返します。getJsp()ロケールと文字セットのマッピングを返します。MIME 型のマッピングを返します。protected final FileSE有効なディレクトリを指している場合は絶対ドキュメントルートを返し、警告をログに記録し、それ以外の場合はnullを返します。protected final FileSEprotected final FileSEgetValidSessionStoreDir(boolean mkdirs) booleanデフォルトのサーブレットを登録する必要があることを示すフラグ。protected final ServletContextInitializer[]mergeInitializers(ServletContextInitializer... initializers) 指定されたServletContextInitializerパラメーターをこのインスタンスで定義されたものと結合するサブクラスで使用できるユーティリティメソッド。voidsetContextPath(StringSE contextPath) Web サーバーのコンテキストパスを設定します。voidsetCookieSameSiteSuppliers(ListSE<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers) 追加された Cookie のCookie.SameSite属性を取得するために使用する必要があるCookieSameSiteSuppliersを設定します。voidsetDisplayName(StringSE displayName) Web サーバーにデプロイされたアプリケーションの表示名を設定します。voidsetDocumentRoot(FileSE documentRoot) 静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートディレクトリを設定します。voidsetInitializers(ListSE<? extends ServletContextInitializer> initializers) ServletWebServerFactory.getWebServer(ServletContextInitializer...)パラメーターに加えて適用する必要があるServletContextInitializerを設定します。voidsetInitParameters(MapSE<StringSE, StringSE> initParameters) コンテナーのServletContextEE に適用される初期化パラメーターを設定します。voidサーバーの JSP サーブレットに適用される構成を設定します。voidsetLocaleCharsetMappings(MapSE<LocaleSE, CharsetSE> localeCharsetMappings) ロケールと文字セットのマッピングを設定します。voidsetMimeMappings(MimeMappings mimeMappings) MIME 型のマッピングを設定します。voidsetRegisterDefaultServlet(boolean registerDefaultServlet) DefaultServlet を登録する必要がある場合に設定します。voidsetSession(Session session) コンテナーの HTTP セッションサポートに適用される構成を設定します。protected booleanJSP サーブレットを Web サーバーに登録する必要があるかどうかを返します。クラス 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インターフェース org.springframework.boot.web.servlet.server.ServletWebServerFactory から継承されたメソッド
getWebServer
フィールドの詳細
logger
コンストラクターの詳細
AbstractServletWebServerFactory
public AbstractServletWebServerFactory()新しいAbstractServletWebServerFactoryインスタンスを作成します。AbstractServletWebServerFactory
public AbstractServletWebServerFactory(int port) 指定されたポートで新しいAbstractServletWebServerFactoryインスタンスを作成します。- パラメーター:
port- Web サーバーのポート番号
AbstractServletWebServerFactory
指定したコンテキストパスとポートを使用して、新しいAbstractServletWebServerFactoryインスタンスを作成します。- パラメーター:
contextPath- Web サーバーのコンテキストパスport- Web サーバーのポート番号
メソッドの詳細
getContextPath
Web サーバーのコンテキストパスを返します。パスは "/" で始まり、"/" で終わりません。ルートコンテキストは空の文字列で表されます。- 戻り値:
- コンテキストパス
setContextPath
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryWeb サーバーのコンテキストパスを設定します。コンテキストは "/" 文字で開始する必要がありますが、"/" 文字で終了することはできません。デフォルトのコンテキストパスは、空の文字列を使用して指定できます。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetContextPath - パラメーター:
contextPath- 設定する contextPath
getDisplayName
setDisplayName
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryWeb サーバーにデプロイされたアプリケーションの表示名を設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetDisplayName - パラメーター:
displayName- 設定する displayName
isRegisterDefaultServlet
public boolean isRegisterDefaultServlet()デフォルトのサーブレットを登録する必要があることを示すフラグ。- 戻り値:
- デフォルトのサーブレットを登録する場合は true
setRegisterDefaultServlet
public void setRegisterDefaultServlet(boolean registerDefaultServlet) インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryDefaultServlet を登録するかどうかを設定します。2.4 以降、デフォルトはfalseです。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetRegisterDefaultServlet - パラメーター:
registerDefaultServlet- デフォルトのサーブレットを登録する必要がある場合
getMimeMappings
MIME 型のマッピングを返します。- 戻り値:
- mimeMappings は MIME 型 マッピングです。
setMimeMappings
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryMIME 型のマッピングを設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetMimeMappings - パラメーター:
mimeMappings- MIME 型のマッピング (デフォルトはMimeMappings.DEFAULT)
addMimeMappings
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryMIME 型 マッピングを追加します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのaddMimeMappings - パラメーター:
mimeMappings- 追加する MIME 型のマッピング
getDocumentRoot
静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートを返します。- 戻り値:
- ドキュメントルート
setDocumentRoot
インターフェースからコピーされた説明:ConfigurableServletWebServerFactory静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートディレクトリを設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetDocumentRoot - パラメーター:
documentRoot- 不要な場合はドキュメントルートまたはnull
setInitializers
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryServletWebServerFactory.getWebServer(ServletContextInitializer...)パラメーターに加えて適用する必要があるServletContextInitializerを設定します。このメソッドは、以前に設定または追加された初期化子を置き換えます。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetInitializers - パラメーター:
initializers- 設定する初期化子- 関連事項:
addInitializers
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryServletWebServerFactory.getWebServer(ServletContextInitializer...)パラメーターに加えて、適用する必要があるものにServletContextInitializerを追加します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのaddInitializers - パラメーター:
initializers- 追加する初期化子- 関連事項:
getJsp
setJsp
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryサーバーの JSP サーブレットに適用される構成を設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetJsp - パラメーター:
jsp- JSP サーブレット構成
getSession
setSession
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryコンテナーの HTTP セッションサポートに適用される構成を設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetSession - パラメーター:
session- セッション構成
getLocaleCharsetMappings
ロケールと文字セットのマッピングを返します。- 戻り値:
- 文字セットマッピング
setLocaleCharsetMappings
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryロケールと文字セットのマッピングを設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetLocaleCharsetMappings - パラメーター:
localeCharsetMappings- ロケールから文字セットへのマッピング
setInitParameters
インターフェースからコピーされた説明:ConfigurableServletWebServerFactoryコンテナーのServletContextEE に適用される初期化パラメーターを設定します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetInitParameters - パラメーター:
initParameters- 初期化パラメーター
getInitParameters
setCookieSameSiteSuppliers
public void setCookieSameSiteSuppliers(ListSE<? extends CookieSameSiteSupplier> cookieSameSiteSuppliers) インターフェースからコピーされた説明:ConfigurableServletWebServerFactory追加された Cookie のCookie.SameSite属性を取得するために使用する必要があるCookieSameSiteSuppliersを設定します。この方法は、以前に設定または追加されたサプライヤーを置き換えます。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのsetCookieSameSiteSuppliers - パラメーター:
cookieSameSiteSuppliers- 追加するサプライヤー- 関連事項:
addCookieSameSiteSuppliers
インターフェースからコピーされた説明:ConfigurableServletWebServerFactory追加された Cookie のCookie.SameSite属性を取得するために使用する必要があるものにCookieSameSiteSuppliersを追加します。- 次で指定:
- インターフェース
ConfigurableServletWebServerFactoryのaddCookieSameSiteSuppliers - パラメーター:
cookieSameSiteSuppliers- 追加するサプライヤー- 関連事項:
getCookieSameSiteSuppliers
mergeInitializers
protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers) 指定されたServletContextInitializerパラメーターをこのインスタンスで定義されたものと結合するサブクラスで使用できるユーティリティメソッド。- パラメーター:
initializers- マージする初期化子- 戻り値:
- マージされた初期化子の完全なセット (指定したパラメーターが最初に表示されます)
shouldRegisterJspServlet
protected boolean shouldRegisterJspServlet()JSP サーブレットを Web サーバーに登録する必要があるかどうかを返します。- 戻り値:
- サーブレットを登録する必要がある場合は
true、それ以外の場合はfalse
getValidDocumentRoot
有効なディレクトリを指している場合は絶対ドキュメントルートを返し、警告をログに記録し、それ以外の場合はnullを返します。- 戻り値:
- 有効なドキュメントルート
getUrlsOfJarsWithMetaInfResources
getValidSessionStoreDir
getValidSessionStoreDir
addWebListeners
インターフェースからコピーされた説明:WebListenerRegistryサーブレットコンテナーに登録される Web リスナーを追加します。- 次で指定:
- インターフェース
WebListenerRegistryのaddWebListeners - パラメーター:
webListenerClassNames- Web リスナーのクラス名
getWebListenerClassNames