パッケージ jakarta.servlet
インターフェース FilterRegistration
- すべてのスーパーインターフェース:
Registration
- すべての既知のサブインターフェース:
FilterRegistration.Dynamic
public interface FilterRegistration extends Registration
Filter
をさらに構成できるインターフェース。- 導入:
- Servlet 3.0
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 インターフェース 説明 static interface
FilterRegistration.Dynamic
ServletContext
上の addFilter メソッドの 1 つを介して登録されたFilter
をさらに構成できるインターフェース。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 void
addMappingForServletNames(EnumSetSE<DispatcherType> dispatcherTypes, boolean isMatchAfter, StringSE... servletNames)
この FilterRegistration によって表されるフィルターの指定されたサーブレット名とディスパッチャー型を使用してフィルターマッピングを追加します。void
addMappingForUrlPatterns(EnumSetSE<DispatcherType> dispatcherTypes, boolean isMatchAfter, StringSE... urlPatterns)
この FilterRegistration によって表されるフィルターの指定された URL パターンとディスパッチャー型を使用してフィルターマッピングを追加します。CollectionSE<StringSE>
getServletNameMappings()
このFilterRegistration
で表される Filter の現在利用可能なサーブレット名マッピングを取得します。CollectionSE<StringSE>
getUrlPatternMappings()
このFilterRegistration
によって表されるフィルターの現在利用可能な URL パターンマッピングを取得します。インターフェース jakarta.servlet.Registration から継承されたメソッド
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
メソッドの詳細
addMappingForServletNames
void addMappingForServletNames(EnumSetSE<DispatcherType> dispatcherTypes, boolean isMatchAfter, StringSE... servletNames)
この FilterRegistration によって表されるフィルターの指定されたサーブレット名とディスパッチャー型を使用してフィルターマッピングを追加します。フィルターマッピングは、追加された順に照合されます。
isMatchAfter パラメーターの値に応じて、指定されたフィルターマッピングは、この FilterRegistration が取得された ServletContext の宣言されたフィルターマッピングの後または前に考慮されます。
このメソッドが複数回呼び出される場合、連続する呼び出しごとに前者の効果が追加されます。
- パラメーター:
dispatcherTypes
- フィルターマッピングのディスパッチャー型。デフォルトの DispatcherType.REQUEST を使用する場合は nullisMatchAfter
- 指定されたフィルターマッピングが宣言されたフィルターマッピングの後に一致する必要がある場合は true、この FilterRegistration の取得元である ServletContext の宣言されたフィルターマッピングの前に一致すると想定される場合は falseservletNames
- フィルターマッピングのサーブレット名- 例外:
IllegalArgumentExceptionSE
- servletNames が null または空の場合IllegalStateExceptionSE
- この FilterRegistration の取得元の ServletContext がすでに初期化されている場合
getServletNameMappings
CollectionSE<StringSE> getServletNameMappings()
このFilterRegistration
で表される Filter の現在利用可能なサーブレット名マッピングを取得します。許可されている場合、返された
Collection
への変更は、このFilterRegistration
に影響してはなりません。- 戻り値:
- この
FilterRegistration
によって表されるフィルターの現在利用可能なサーブレット名マッピングの(おそらく空の)Collection
addMappingForUrlPatterns
void addMappingForUrlPatterns(EnumSetSE<DispatcherType> dispatcherTypes, boolean isMatchAfter, StringSE... urlPatterns)
この FilterRegistration によって表されるフィルターの指定された URL パターンとディスパッチャー型を使用してフィルターマッピングを追加します。フィルターマッピングは、追加された順に照合されます。
isMatchAfter パラメーターの値に応じて、指定されたフィルターマッピングは、この FilterRegistration が取得された ServletContext の宣言されたフィルターマッピングの後または前に考慮されます。
このメソッドが複数回呼び出される場合、連続する呼び出しごとに前者の効果が追加されます。
- パラメーター:
dispatcherTypes
- フィルターマッピングのディスパッチャー型。デフォルトの DispatcherType.REQUEST を使用する場合は nullisMatchAfter
- 指定されたフィルターマッピングが宣言されたフィルターマッピングの後に一致する必要がある場合は true、この FilterRegistration の取得元である ServletContext の宣言されたフィルターマッピングの前に一致すると想定される場合は falseurlPatterns
- フィルターマッピングの URL パターン- 例外:
IllegalArgumentExceptionSE
- urlPatterns が null または空の場合IllegalStateExceptionSE
- この FilterRegistration の取得元の ServletContext がすでに初期化されている場合
getUrlPatternMappings
CollectionSE<StringSE> getUrlPatternMappings()
このFilterRegistration
によって表されるフィルターの現在利用可能な URL パターンマッピングを取得します。許可されている場合、返された
Collection
への変更は、このFilterRegistration
に影響してはなりません。- 戻り値:
- この
FilterRegistration
によって表されるフィルターの現在利用可能な URL パターンマッピングの(おそらく空の)Collection