ServletRegistrationBean (Spring Boot Docs 2.2.1.RELEASE API)

java.lang.ObjectSE
- org.springframework.boot.web.servlet.RegistrationBean
- - org.springframework.boot.web.servlet.DynamicRegistrationBean<ServletRegistration.DynamicEE>
  - - org.springframework.boot.web.servlet.ServletRegistrationBean<T>

型パラメーター:
T - 登録する ServletEE の型
実装済みのインターフェース一覧:
ServletContextInitializer, org.springframework.core.Ordered
既知の直属サブクラス
DispatcherServletRegistrationBean
```
public class ServletRegistrationBean<T extends ServletEE>
extends DynamicRegistrationBean<ServletRegistration.DynamicEE>
```
ServletEE を Servlet 3.0+ コンテナーに登録する ServletContextInitializer。ServletContextEE が提供する registrationEE 機能に似ていますが、Spring Bean フレンドリーなデザインです。
RegistrationBean.onStartup(javax.servlet.ServletContext) を呼び出す前に、servlet を指定する必要があります。URL マッピングは、setUrlMappings(java.util.Collection<java.lang.String>) を使用して構成するか、"/*" にマッピングするときに省略できます（alwaysMapUrl が false に設定されている場合を除く）。指定しない場合、サーブレット名が推測されます。
導入:
1.4.0
作成者:
Phillip Webb
関連事項:
ServletContextInitializer, ServletContext.addServlet(String, Servlet)EE

フィールド概要
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

コンストラクター概要

コンストラクター
コンストラクターと説明
`ServletRegistrationBean()` 新しい `ServletRegistrationBean` インスタンスを作成します。
`ServletRegistrationBean(T servlet, boolean alwaysMapUrl, StringSE... urlMappings)` 指定された `Servlet`EE および URL マッピングを使用して、新しい `ServletRegistrationBean` インスタンスを作成します。
`ServletRegistrationBean(T servlet, StringSE... urlMappings)` 指定された `Servlet`EE および URL マッピングを使用して、新しい `ServletRegistrationBean` インスタンスを作成します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ServletRegistration.DynamicEE`	`addRegistration(StringSE description, ServletContextEE servletContext)`
`void`	`addUrlMappings(StringSE... urlMappings)` サーブレット仕様に定義されているように、サーブレットの URL マッピングを追加します。
`protected void`	`configure(ServletRegistration.DynamicEE registration)` 登録設定を構成します。
`protected StringSE`	`getDescription()` 登録の説明を返します。
`MultipartConfigElementEE`	`getMultipartConfig()` 適用する `multi-part configuration`EE または `null` を返します。
`T`	`getServlet()` 登録されているサーブレットを返します。
`StringSE`	`getServletName()` 登録されるサーブレット名を返します。
`CollectionSE<StringSE>`	`getUrlMappings()` サーブレット仕様で定義されている、サーブレットの URL マッピングの変更可能なコレクションを返します。
`void`	`setLoadOnStartup(int loadOnStartup)` `loadOnStartup` 優先度を設定します。
`void`	`setMultipartConfig(MultipartConfigElementEE multipartConfig)` `multi-part configuration`EE を設定してください。
`void`	`setServlet(T servlet)` 登録するサーブレットを設定します。
`void`	`setUrlMappings(CollectionSE<StringSE> urlMappings)` サーブレットの URL マッピングを設定します。
`StringSE`	`toString()`

クラス org.springframework.boot.web.servlet.DynamicRegistrationBean から継承されたメソッド
addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setInitParameters, setName

クラス org.springframework.boot.web.servlet.RegistrationBean から継承されたメソッド
getOrder, isEnabled, onStartup, setEnabled, setOrder

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ServletRegistrationBean
```
public ServletRegistrationBean()
```
    新しい ServletRegistrationBean インスタンスを作成します。
  - ServletRegistrationBean
```
public ServletRegistrationBean(T servlet,
                               StringSE... urlMappings)
```
    指定された ServletEE および URL マッピングを使用して、新しい ServletRegistrationBean インスタンスを作成します。
    パラメーター:
    servlet - マッピングされるサーブレット
    urlMappings - マッピングされている URL
  - ServletRegistrationBean
```
public ServletRegistrationBean(T servlet,
                               boolean alwaysMapUrl,
                               StringSE... urlMappings)
```
    指定された ServletEE および URL マッピングを使用して、新しい ServletRegistrationBean インスタンスを作成します。
    パラメーター:
    servlet - マッピングされるサーブレット
    alwaysMapUrl - 省略した場合、URL マッピングは "/*" に置き換える必要があります
    urlMappings - マッピングされている URL
- メソッドの詳細
  - setServlet
```
public void setServlet(T servlet)
```
    登録するサーブレットを設定します。
    パラメーター:
    servlet - サーブレット
  - getServlet
```
public T getServlet()
```
    登録されているサーブレットを返します。
    戻り値:
    サーブレット
  - setUrlMappings
```
public void setUrlMappings(CollectionSE<StringSE> urlMappings)
```
    サーブレットの URL マッピングを設定します。指定しない場合、マッピングはデフォルトで "/" になります。これにより、以前に指定されたマッピングが置き換えられます。
    パラメーター:
    urlMappings - 設定するマッピング
    関連事項:
    addUrlMappings(String...)
  - getUrlMappings
```
public CollectionSE<StringSE> getUrlMappings()
```
    サーブレット仕様で定義されている、サーブレットの URL マッピングの変更可能なコレクションを返します。
    戻り値:
    urlMappings
  - addUrlMappings
```
public void addUrlMappings(StringSE... urlMappings)
```
    サーブレット仕様に定義されているように、サーブレットの URL マッピングを追加します。
    パラメーター:
    urlMappings - 追加するマッピング
    関連事項:
    setUrlMappings(Collection)
  - setLoadOnStartup
```
public void setLoadOnStartup(int loadOnStartup)
```
    loadOnStartup 優先度を設定します。詳細については、ServletRegistration.Dynamic#setLoadOnStartup を参照してください。
    パラメーター:
    loadOnStartup - 起動時のロードが有効になっている場合
  - setMultipartConfig
```
public void setMultipartConfig(MultipartConfigElementEE multipartConfig)
```
    multi-part configurationEE を設定してください。
    パラメーター:
    multipartConfig - 設定するマルチパート構成または null
  - getMultipartConfig
```
public MultipartConfigElementEE getMultipartConfig()
```
    適用する multi-part configurationEE または null を返します。
    戻り値:
    マルチパート構成
  - getDescription
```
protected StringSE getDescription()
```
    クラスからコピーされた説明: RegistrationBean
    登録の説明を返します。例: "Servlet resourceServlet"
    次で指定:
    クラス RegistrationBean の getDescription
    戻り値:
    登録の説明
  - addRegistration
```
protected ServletRegistration.DynamicEE addRegistration(StringSE description,
                                                      ServletContextEE servletContext)
```
    次で指定:
    クラス DynamicRegistrationBean<ServletRegistration.DynamicEE> の addRegistration
  - configure
```
protected void configure(ServletRegistration.DynamicEE registration)
```
    登録設定を構成します。必要に応じて、サブクラスはこのメソッドをオーバーライドして追加の構成を実行できます。
    オーバーライド:
    クラス DynamicRegistrationBean<ServletRegistration.DynamicEE> の configure
    パラメーター:
    registration - 登録
  - getServletName
```
public StringSE getServletName()
```
    登録されるサーブレット名を返します。
    戻り値:
    サーブレット名
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス ServletRegistrationBean<T extends ServletEE>

フィールド概要

インターフェース org.springframework.core.Ordered から継承されたフィールド

コンストラクター概要

方法の概要

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

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

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

コンストラクターの詳細

ServletRegistrationBean

ServletRegistrationBean

ServletRegistrationBean

メソッドの詳細

setServlet

getServlet

setUrlMappings

getUrlMappings

addUrlMappings

setLoadOnStartup

setMultipartConfig

getMultipartConfig

getDescription

addRegistration

configure

getServletName

toString