クラス ServletRegistrationBean<T extends ServletEE>
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
- 登録するServlet
EE の型
- 実装されたすべてのインターフェース:
Aware
、BeanNameAware
、ServletContextInitializer
、Ordered
- 既知の直属サブクラス
DispatcherServletRegistrationBean
public class ServletRegistrationBean<T extends ServletEE>
extends DynamicRegistrationBean<ServletRegistration.DynamicEE>
Servlet
EE を Servlet 3.0+ コンテナーに登録する ServletContextInitializer
。ServletContext
EE が提供する registration
EE 機能に似ていますが、Spring Bean フレンドリーなデザインです。RegistrationBean.onStartup(jakarta.servlet.ServletContext)
を呼び出す前に、servlet
を指定する必要があります。URL マッピングは、setUrlMappings(java.util.Collection<java.lang.String>)
を使用して構成するか、"/*" にマッピングするときに省略できます(alwaysMapUrl
が false
に設定されている場合を除く)。指定しない場合、サーブレット名が推測されます。
- 導入:
- 1.4.0
- 作成者:
- Phillip Webb
- 関連事項:
フィールドサマリー
インターフェース org.springframework.core.Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
コンストラクターのサマリー
コンストラクターコンストラクター説明新しい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
登録の説明を返します。適用するmulti-part configuration
EE またはnull
を返します。登録されているサーブレットを返します。登録されるサーブレット名を返します。サーブレット仕様で定義されている、サーブレットの URL マッピングの変更可能なコレクションを返します。void
setLoadOnStartup
(int loadOnStartup) loadOnStartup
優先度を設定します。void
setMultipartConfig
(MultipartConfigElementEE multipartConfig) multi-part configuration
EE を設定してください。void
setServlet
(T servlet) 登録するサーブレットを設定します。void
setUrlMappings
(CollectionSE<StringSE> urlMappings) サーブレットの URL マッピングを設定します。toString()
クラス org.springframework.boot.web.servlet.DynamicRegistrationBean から継承されたメソッド
addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setName
クラス org.springframework.boot.web.servlet.RegistrationBean から継承されたメソッド
getOrder, isEnabled, onStartup, setEnabled, setOrder
コンストラクターの詳細
ServletRegistrationBean
public ServletRegistrationBean()新しいServletRegistrationBean
インスタンスを作成します。ServletRegistrationBean
指定されたServlet
EE および URL マッピングを使用して、新しいServletRegistrationBean
インスタンスを作成します。- パラメーター:
servlet
- マッピングされるサーブレットurlMappings
- マッピングされている URL
ServletRegistrationBean
指定されたServlet
EE および URL マッピングを使用して、新しいServletRegistrationBean
インスタンスを作成します。- パラメーター:
servlet
- マッピングされるサーブレットalwaysMapUrl
- 省略した場合、URL マッピングは "/*" に置き換える必要がありますurlMappings
- マッピングされている URL
メソッドの詳細
setServlet
登録するサーブレットを設定します。- パラメーター:
servlet
- サーブレット
getServlet
登録されているサーブレットを返します。- 戻り値:
- サーブレット
setUrlMappings
サーブレットの URL マッピングを設定します。指定しない場合、マッピングはデフォルトで "/" になります。これにより、以前に指定されたマッピングが置き換えられます。- パラメーター:
urlMappings
- 設定するマッピング- 関連事項:
getUrlMappings
サーブレット仕様で定義されている、サーブレットの URL マッピングの変更可能なコレクションを返します。- 戻り値:
- urlMappings
addUrlMappings
サーブレット仕様に定義されているように、サーブレットの URL マッピングを追加します。- パラメーター:
urlMappings
- 追加するマッピング- 関連事項:
setLoadOnStartup
public void setLoadOnStartup(int loadOnStartup) loadOnStartup
プライオリティを設定します。詳細については、ServletRegistration.Dynamic.setLoadOnStartup(int)
EE を参照してください。- パラメーター:
loadOnStartup
- 起動時のロードが有効になっている場合
setMultipartConfig
multi-part configuration
EE を設定してください。- パラメーター:
multipartConfig
- 設定するマルチパート構成またはnull
getMultipartConfig
適用するmulti-part configuration
EE またはnull
を返します。- 戻り値:
- マルチパート構成
getDescription
クラスからコピーされた説明:RegistrationBean
登録の説明を返します。たとえば、「サーブレット resourceServlet」- 次で指定:
- クラス
RegistrationBean
のgetDescription
- 戻り値:
- 登録の説明
addRegistration
protected ServletRegistration.DynamicEE addRegistration(StringSE description, ServletContextEE servletContext) configure
登録設定を構成します。必要に応じて、サブクラスはこのメソッドをオーバーライドして追加の構成を実行できます。- オーバーライド:
- クラス
DynamicRegistrationBean<ServletRegistration.DynamicEE>
のconfigure
- パラメーター:
registration
- 登録
getServletName
登録されるサーブレット名を返します。- 戻り値:
- サーブレット名
toString