クラス AbstractFilterRegistrationBean<T extends FilterEE>
java.lang.ObjectSE
org.springframework.boot.web.servlet.RegistrationBean
org.springframework.boot.web.servlet.DynamicRegistrationBean<FilterRegistration.DynamicEE>
org.springframework.boot.web.servlet.AbstractFilterRegistrationBean<T>
- 型パラメーター:
T- 登録するFilterEE の型
- 実装されているすべてのインターフェース:
Aware, BeanNameAware, ServletContextInitializer, Ordered
public abstract class AbstractFilterRegistrationBean<T extends FilterEE>
extends DynamicRegistrationBean<FilterRegistration.DynamicEE>
ベース
ServletContextInitializer を抽象化して、FilterEE を Servlet 3.0+ コンテナーに登録します。- 導入:
- 1.5.22
- 作成者:
- Phillip Webb, Brian Clozel
フィールドのサマリー
インターフェース Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE方法の概要
修飾子と型メソッド説明protected FilterRegistration.DynamicEEaddRegistration(StringSE description, ServletContextEE servletContext) voidaddServletNames(StringSE... servletNames) フィルターのサーブレット名を追加します。voidaddServletRegistrationBeans(ServletRegistrationBean<?>... servletRegistrationBeans) フィルターにServletRegistrationBeanを追加します。voidaddUrlPatterns(StringSE... urlPatterns) サーブレット仕様で定義されているように、フィルターが登録される URL パターンを追加します。protected voidconfigure(FilterRegistration.DynamicEE registration) 登録設定を構成します。フィルターを登録する必要があるdispatcher typesEE を決定します。protected StringSE登録の説明を返します。abstract @Nullable T登録するFilterEE を返します。登録されるフィルター名を返します。フィルターが登録されるサーブレット名の可変コレクションを返します。フィルターが登録されるServletRegistrationBeanの可変コレクションを返します。フィルターが登録されるサーブレット仕様で定義されている URL パターンの変更可能なコレクションを返します。booleanServletContext の宣言されたフィルターマッピングの後にフィルターマッピングを一致させる必要がある場合に返します。voidsetDispatcherTypes(DispatcherTypeEE first, DispatcherTypeEE... rest) 指定された要素を使用したset dispatcher typesへの簡易メソッド。voidsetDispatcherTypes(@Nullable EnumSetSE<DispatcherTypeEE> dispatcherTypes) 登録で使用するディスパッチャー型を設定します。voidsetMatchAfter(boolean matchAfter) ServletContext の宣言されたフィルターマッピングの後にフィルターマッピングを一致させる必要がある場合に設定します。voidsetServletNames(CollectionSE<StringSE> servletNames) フィルターが登録されるサーブレット名を設定します。voidsetServletRegistrationBeans(CollectionSE<? extends ServletRegistrationBean<?>> servletRegistrationBeans) フィルターが登録されるServletRegistrationBeanを設定します。voidsetUrlPatterns(CollectionSE<StringSE> urlPatterns) フィルターが登録される URL パターンを設定します。toString()クラス DynamicRegistrationBean から継承されたメソッド
addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setNameクラス RegistrationBean から継承されたメソッド
getOrder, isEnabled, onStartup, setEnabled, setOrder
メソッドの詳細
setServletRegistrationBeans
public void setServletRegistrationBeans(CollectionSE<? extends ServletRegistrationBean<?>> servletRegistrationBeans) フィルターが登録されるServletRegistrationBeanを設定します。- パラメーター:
servletRegistrationBeans- サーブレット登録 Bean
getServletRegistrationBeans
フィルターが登録されるServletRegistrationBeanの可変コレクションを返します。ServletRegistrationBeans。- 戻り値:
- サーブレット登録 Bean
- 関連事項:
addServletRegistrationBeans
フィルターにServletRegistrationBeanを追加します。- パラメーター:
servletRegistrationBeans- 追加するサーブレット登録 Bean- 関連事項:
setServletNames
フィルターが登録されるサーブレット名を設定します。これにより、以前に指定されたサーブレット名が置き換えられます。- パラメーター:
servletNames- サーブレット名- 関連事項:
getServletNames
addServletNames
フィルターのサーブレット名を追加します。- パラメーター:
servletNames- 追加するサーブレット名
setUrlPatterns
フィルターが登録される URL パターンを設定します。これは、以前に指定された URL パターンを置き換えます。- パラメーター:
urlPatterns- URL パターン- 関連事項:
getUrlPatterns
フィルターが登録されるサーブレット仕様で定義されている URL パターンの変更可能なコレクションを返します。- 戻り値:
- URL パターン
addUrlPatterns
サーブレット仕様で定義されているように、フィルターが登録される URL パターンを追加します。- パラメーター:
urlPatterns- URL パターン
determineDispatcherTypes
フィルターを登録する必要があるdispatcher typesEE を決定します。何も設定されていない場合は、登録されているフィルターの型に基づいてデフォルトを適用します。返されたEnumSetSE を変更しても、登録には影響しません。- 戻り値:
- ディスパッチャーの型 (決して
nullではない) - 導入:
- 3.2.0
setDispatcherTypes
指定された要素を使用したset dispatcher typesへの簡易メソッド。- パラメーター:
first- 最初のディスパッチャー型rest- 追加のディスパッチャー型
setDispatcherTypes
登録で使用するディスパッチャー型を設定します。- パラメーター:
dispatcherTypes- ディスパッチャーの型
setMatchAfter
public void setMatchAfter(boolean matchAfter) ServletContext の宣言されたフィルターマッピングの後にフィルターマッピングを一致させる必要がある場合に設定します。デフォルトはfalseで、ServletContext の宣言されたフィルターマッピングの前にフィルターが一致することを示します。- パラメーター:
matchAfter- フィルターマッピングが後に一致する場合
isMatchAfter
public boolean isMatchAfter()ServletContext の宣言されたフィルターマッピングの後にフィルターマッピングを一致させる必要がある場合に返します。- 戻り値:
- フィルターマッピングが後に一致する場合
getDescription
クラスからコピーされた説明:RegistrationBean登録の説明を返します。例: "Servlet resourceServlet"- 次で指定:
- クラス
RegistrationBeanのgetDescription - 戻り値:
- 登録の説明
addRegistration
protected FilterRegistration.DynamicEE addRegistration(StringSE description, ServletContextEE servletContext) configure
登録設定を構成します。必要に応じて、サブクラスはこのメソッドをオーバーライドして追加の構成を実行できます。- オーバーライド:
- クラス
DynamicRegistrationBean<FilterRegistration.DynamicEE>のconfigure - パラメーター:
registration- 登録
getFilter
getFilterName
toString