javax.servlet

インタフェース FilterRegistration

すべてのスーパーインタフェース:

Registration

既知のサブインタフェースのリスト:

FilterRegistration.Dynamic

public interface FilterRegistration
extends Registration

Filter に詳細な構成をするためのインターフェース。

導入されたバージョン:

Servlet 3.0

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static interface	FilterRegistration.Dynamic ServletContextのaddFilterメソッドの1つを使用して登録された Filterを詳細に構成するためのインターフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames) このFilterRegistrationによって表されるフィルターに対して、与えられたサーブレット名とディスパッチャータイプを持つフィルターマッピングを追加します。
void	addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns) このFilterRegistrationによって表されるフィルターに対して、与えられたURLパターンとディスパッチャータイプを持つフィルターマッピングを追加します。
Collection<String>	getServletNameMappings() このFilterRegistrationの表すフィルターの現在使用可能なサーブレット名のマッピングを取得します。
Collection<String>	getUrlPatternMappings() このFilterRegistrationの表すフィルターの現在使用可能なURLパターンマッピングを取得します。

インタフェースから継承されたメソッド javax.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

メソッドの詳細

addMappingForServletNames

void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
                               boolean isMatchAfter,
                               String... servletNames)

このFilterRegistrationによって表されるフィルターに対して、与えられたサーブレット名とディスパッチャータイプを持つフィルターマッピングを追加します。

フィルターマッピングは追加された順番で一致します。

isMatchAfterパラメータの値に応じて、このFilterRegistrationが取得されたServletContextで宣言された フィルターマッピングの後または前に、与えられたフィルターマッピングを設定します。

このメソッドが複数回呼び出された場合、後続の各呼び出しが前の呼び出しの効果に追加されます。

パラメータ:

dispatcherTypes - フィルターマッピングのディスパッチャータイプ、 nullの場合はデフォルトとして DispatcherType.REQUESTが使用される

isMatchAfter - 与えられたフィルターマッピングが宣言されたフィルターマッピングの後で一致する必要がある場合はtrue、 このFilterRegistrationが取得されたServletContextで宣言されたフィルターマッピングの前に一致しなければならない場合はfalse

servletNames - フィルターマッピングのサーブレット名

例外:

IllegalArgumentException - servletNamesがnullもしくは空の場合

IllegalStateException - このFilterRegistrationが取得されたServletContextがすでに初期化完了していた場合

getServletNameMappings

Collection<String> getServletNameMappings()

このFilterRegistrationの表すフィルターの現在使用可能なサーブレット名のマッピングを取得します。

許可されている場合、返されたCollectionへの変更はこのFilterRegistrationに影響してはなりません。

戻り値:

このFilterRegistrationによって表されるフィルターの現在利用可能なサーブレット名のマッピングの(空の可能性のある)Collection

addMappingForUrlPatterns

void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
                              boolean isMatchAfter,
                              String... urlPatterns)

このFilterRegistrationによって表されるフィルターに対して、与えられたURLパターンとディスパッチャータイプを持つフィルターマッピングを追加します。

フィルターマッピングは追加された順番で一致します。

isMatchAfterパラメータの値に応じて、このFilterRegistrationが取得されたServletContextで宣言された フィルターマッピングの後または前に、与えられたフィルターマッピングを設定します。

このメソッドが複数回呼び出された場合、後続の各呼び出しが前の呼び出しの効果に追加されます。

パラメータ:

dispatcherTypes - フィルターマッピングのディスパッチャータイプ、 nullの場合はデフォルトとして DispatcherType.REQUESTが使用される

isMatchAfter - 与えられたフィルターマッピングが宣言されたフィルターマッピングの後で一致する必要がある場合はtrue、 このFilterRegistrationが取得されたServletContextで宣言されたフィルターマッピングの前に一致しなければならない場合はfalse

urlPatterns - フィルターマッピングのURLパターン

例外:

IllegalArgumentException - urlPatternsがnullもしくは空

IllegalStateException - このFilterRegistrationが取得されたServletContextがすでに初期化完了していた場合

getUrlPatternMappings

Collection<String> getUrlPatternMappings()

このFilterRegistrationの表すフィルターの現在使用可能なURLパターンマッピングを取得します。

許可されている場合、返されたCollectionへの変更はこのFilterRegistrationに影響してはなりません。

戻り値:

このFilterRegistrationによって表されるフィルターの現在利用可能なURLパターンマッピングの(空の可能性のある)Collection