AbstractServletWebServerFactory (Spring Boot Docs 2.0.2.RELEASE API)

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

実装されているすべてのインターフェース:
ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory, ConfigurableServletWebServerFactory, ServletWebServerFactory
既知の直属サブクラス
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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`addInitializers(ServletContextInitializer... initializers)` `ServletWebServerFactory.getWebServer(ServletContextInitializer...)` パラメーターに加えて、適用する必要があるものに `ServletContextInitializer` を追加します。
`StringSE`	`getContextPath()` Web サーバーのコンテキストパスを返します。
`protected StringSE`	`getDecodedFile(URLSE url)` 使用すべきではありません。 2.0.2 が `File.File(java.net.URI)`SE を推奨して以来
`StringSE`	`getDisplayName()`
`FileSE`	`getDocumentRoot()` 静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートを返します。
`MapSE<StringSE, StringSE>`	`getInitParameters()`
`Jsp`	`getJsp()`
`MapSE<LocaleSE, CharsetSE>`	`getLocaleCharsetMappings()` ロケールと文字セットのマッピングを返します。
`MimeMappings`	`getMimeMappings()` MIME 型のマッピングを返します。
`Session`	`getSession()`
`protected ListSE<URLSE>`	`getUrlsOfJarsWithMetaInfResources()`
`protected FileSE`	`getValidDocumentRoot()` 有効なディレクトリを指している場合は絶対ドキュメントルートを返し、警告をログに記録し、それ以外の場合は `null` を返します。
`protected FileSE`	`getValidSessionStoreDir()`
`protected FileSE`	`getValidSessionStoreDir(boolean mkdirs)`
`boolean`	`isRegisterDefaultServlet()` デフォルトのサーブレットを登録する必要があることを示すフラグ。
`protected ServletContextInitializer[]`	`mergeInitializers(ServletContextInitializer... initializers)` 指定された `ServletContextInitializer` パラメーターをこのインスタンスで定義されたものと結合するサブクラスで使用できるユーティリティメソッド。
`void`	`setContextPath(StringSE contextPath)` Web サーバーのコンテキストパスを設定します。
`void`	`setDisplayName(StringSE displayName)` Web サーバーにデプロイされたアプリケーションの表示名を設定します。
`void`	`setDocumentRoot(FileSE documentRoot)` 静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートディレクトリを設定します。
`void`	`setInitializers(ListSE<? extends ServletContextInitializer> initializers)` `ServletWebServerFactory.getWebServer(ServletContextInitializer...)` パラメーターに加えて適用する必要がある `ServletContextInitializer` を設定します。
`void`	`setInitParameters(MapSE<StringSE, StringSE> initParameters)` コンテナーの `ServletContext`EE に適用される初期化パラメーターを設定します。
`void`	`setJsp(Jsp jsp)` サーバーの JSP サーブレットに適用される構成を設定します。
`void`	`setLocaleCharsetMappings(MapSE<LocaleSE, CharsetSE> localeCharsetMappings)` ロケールと文字セットのマッピングを設定します。
`void`	`setMimeMappings(MimeMappings mimeMappings)` MIME 型のマッピングを設定します。
`void`	`setRegisterDefaultServlet(boolean registerDefaultServlet)` DefaultServlet を登録する必要がある場合に設定します。
`void`	`setSession(Session session)` コンテナーの HTTP セッションサポートに適用される構成を設定します。
`protected boolean`	`shouldRegisterJspServlet()` JSP サーブレットを Web サーバーに登録する必要があるかどうかを返します。

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

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory()
```
    新しい AbstractServletWebServerFactory インスタンスを作成します。
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory(int port)
```
    指定されたポートで新しい AbstractServletWebServerFactory インスタンスを作成します。
    パラメーター:
    port - Web サーバーのポート番号
  - AbstractServletWebServerFactory
```
public AbstractServletWebServerFactory(StringSE contextPath,
                                       int port)
```
    指定したコンテキストパスとポートを使用して、新しい AbstractServletWebServerFactory インスタンスを作成します。
    パラメーター:
    contextPath - Web サーバーのコンテキストパス
    port - Web サーバーのポート番号
- メソッドの詳細
  - getContextPath
```
public StringSE getContextPath()
```
    Web サーバーのコンテキストパスを返します。パスは "/" で始まり、"/" で終わりません。ルートコンテキストは空の文字列で表されます。
    戻り値:
    コンテキストパス
  - setContextPath
```
public void setContextPath(StringSE contextPath)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    Web サーバーのコンテキストパスを設定します。コンテキストは "/" 文字で開始する必要がありますが、"/" 文字で終了することはできません。デフォルトのコンテキストパスは、空の文字列を使用して指定できます。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setContextPath
    パラメーター:
    contextPath - 設定する contextPath
  - getDisplayName
```
public StringSE getDisplayName()
```
  - setDisplayName
```
public void setDisplayName(StringSE displayName)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    Web サーバーにデプロイされたアプリケーションの表示名を設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setDisplayName
    パラメーター:
    displayName - 設定する displayName
  - isRegisterDefaultServlet
```
public boolean isRegisterDefaultServlet()
```
    デフォルトのサーブレットを登録する必要があることを示すフラグ。
    戻り値:
    デフォルトのサーブレットを登録する場合は true
  - setRegisterDefaultServlet
```
public void setRegisterDefaultServlet(boolean registerDefaultServlet)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    DefaultServlet を登録する必要がある場合に設定します。デフォルトは true であるため、document root からのファイルが提供されます。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setRegisterDefaultServlet
    パラメーター:
    registerDefaultServlet - デフォルトのサーブレットを登録する必要がある場合
  - getMimeMappings
```
public MimeMappings getMimeMappings()
```
    MIME 型のマッピングを返します。
    戻り値:
    mimeMappings は MIME 型マッピングです。
  - setMimeMappings
```
public void setMimeMappings(MimeMappings mimeMappings)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    MIME 型のマッピングを設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setMimeMappings
    パラメーター:
    mimeMappings - MIME 型のマッピング (デフォルトは MimeMappings.DEFAULT )
  - getDocumentRoot
```
public FileSE getDocumentRoot()
```
    静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートを返します。
    戻り値:
    ドキュメントルート
  - setDocumentRoot
```
public void setDocumentRoot(FileSE documentRoot)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    静的ファイルを提供するために Web コンテキストで使用されるドキュメントルートディレクトリを設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setDocumentRoot
    パラメーター:
    documentRoot - 不要な場合はドキュメントルートまたは null
  - setInitializers
```
public void setInitializers(ListSE<? extends ServletContextInitializer> initializers)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    ServletWebServerFactory.getWebServer(ServletContextInitializer...) パラメーターに加えて適用する必要がある ServletContextInitializer を設定します。このメソッドは、以前に設定または追加された初期化子を置き換えます。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setInitializers
    パラメーター:
    initializers - 設定する初期化子
    関連事項:
    ConfigurableServletWebServerFactory.addInitializers(org.springframework.boot.web.servlet.ServletContextInitializer...)
  - addInitializers
```
public void addInitializers(ServletContextInitializer... initializers)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    ServletWebServerFactory.getWebServer(ServletContextInitializer...) パラメーターに加えて、適用する必要があるものに ServletContextInitializer を追加します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の addInitializers
    パラメーター:
    initializers - 追加する初期化子
    関連事項:
    ConfigurableServletWebServerFactory.setInitializers(java.util.List<? extends org.springframework.boot.web.servlet.ServletContextInitializer>)
  - getJsp
```
public Jsp getJsp()
```
  - setJsp
```
public void setJsp(Jsp jsp)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    サーバーの JSP サーブレットに適用される構成を設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setJsp
    パラメーター:
    jsp - JSP サーブレット構成
  - getSession
```
public Session getSession()
```
  - setSession
```
public void setSession(Session session)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    コンテナーの HTTP セッションサポートに適用される構成を設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setSession
    パラメーター:
    session - セッション構成
  - getLocaleCharsetMappings
```
public MapSE<LocaleSE,CharsetSE> getLocaleCharsetMappings()
```
    ロケールと文字セットのマッピングを返します。
    戻り値:
    文字セットマッピング
  - setLocaleCharsetMappings
```
public void setLocaleCharsetMappings(MapSE<LocaleSE,CharsetSE> localeCharsetMappings)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    ロケールと文字セットのマッピングを設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setLocaleCharsetMappings
    パラメーター:
    localeCharsetMappings - ロケールから文字セットへのマッピング
  - setInitParameters
```
public void setInitParameters(MapSE<StringSE,StringSE> initParameters)
```
    インターフェースからコピーされた説明: ConfigurableServletWebServerFactory
    コンテナーの ServletContextEE に適用される初期化パラメーターを設定します。
    次で指定:
    インターフェース ConfigurableServletWebServerFactory の setInitParameters
    パラメーター:
    initParameters - 初期化パラメーター
  - getInitParameters
```
public MapSE<StringSE,StringSE> getInitParameters()
```
  - mergeInitializers
```
protected final ServletContextInitializer[] mergeInitializers(ServletContextInitializer... initializers)
```
    指定された ServletContextInitializer パラメーターをこのインスタンスで定義されたものと結合するサブクラスで使用できるユーティリティメソッド。
    パラメーター:
    initializers - マージする初期化子
    戻り値:
    マージされた初期化子の完全なセット (指定したパラメーターが最初に表示されます)
  - shouldRegisterJspServlet
```
protected boolean shouldRegisterJspServlet()
```
    JSP サーブレットを Web サーバーに登録する必要があるかどうかを返します。
    戻り値:
    サーブレットを登録する必要がある場合は true、それ以外の場合は false
  - getValidDocumentRoot
```
protected final FileSE getValidDocumentRoot()
```
    有効なディレクトリを指している場合は絶対ドキュメントルートを返し、警告をログに記録し、それ以外の場合は null を返します。
    戻り値:
    有効なドキュメントルート
  - getUrlsOfJarsWithMetaInfResources
```
protected final ListSE<URLSE> getUrlsOfJarsWithMetaInfResources()
```
  - getDecodedFile
```
@DeprecatedSE
protected final StringSE getDecodedFile(URLSE url)
```
    非推奨。2.0.2 以来 File.File(java.net.URI)SE を推奨
    指定された url をデコードされたファイルパスに変換します。
    パラメーター:
    url - 変換する URL
    戻り値:
    ファイルパス
  - getValidSessionStoreDir
```
protected final FileSE getValidSessionStoreDir()
```
  - getValidSessionStoreDir
```
protected final FileSE getValidSessionStoreDir(boolean mkdirs)
```

クラス AbstractServletWebServerFactory

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

フィールドの詳細

logger

コンストラクターの詳細

AbstractServletWebServerFactory

AbstractServletWebServerFactory

AbstractServletWebServerFactory

メソッドの詳細

getContextPath

setContextPath

getDisplayName

setDisplayName

isRegisterDefaultServlet

setRegisterDefaultServlet

getMimeMappings

setMimeMappings

getDocumentRoot

setDocumentRoot

setInitializers

addInitializers

getJsp

setJsp

getSession

setSession

getLocaleCharsetMappings

setLocaleCharsetMappings

setInitParameters

getInitParameters

mergeInitializers

shouldRegisterJspServlet

getValidDocumentRoot

getUrlsOfJarsWithMetaInfResources

getDecodedFile

getValidSessionStoreDir

getValidSessionStoreDir