パッケージ jakarta.servlet

インターフェース FilterRegistration

    • メソッドの詳細

      • addMappingForServletNames

        void addMappingForServletNames​(EnumSetSE<DispatcherType> dispatcherTypes,
                                       boolean isMatchAfter,
                                       StringSE... servletNames)
        この FilterRegistration によって表されるフィルターの指定されたサーブレット名とディスパッチャー型を使用してフィルターマッピングを追加します。

        フィルターマッピングは、追加された順に照合されます。

        isMatchAfter パラメーターの値に応じて、指定されたフィルターマッピングは、この FilterRegistration が取得された ServletContext の宣言されたフィルターマッピングの後または前に考慮されます。

        このメソッドが複数回呼び出される場合、連続する呼び出しごとに前者の効果が追加されます。

        パラメーター:
        dispatcherTypes - フィルターマッピングのディスパッチャー型。デフォルトの DispatcherType.REQUEST を使用する場合は null
        isMatchAfter - 指定されたフィルターマッピングが宣言されたフィルターマッピングの後に一致する必要がある場合は true、この FilterRegistration の取得元である ServletContext の宣言されたフィルターマッピングの前に一致すると想定される場合は false
        servletNames - フィルターマッピングのサーブレット名
        例外:
        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 を使用する場合は null
        isMatchAfter - 指定されたフィルターマッピングが宣言されたフィルターマッピングの後に一致する必要がある場合は true、この FilterRegistration の取得元である ServletContext の宣言されたフィルターマッピングの前に一致すると想定される場合は false
        urlPatterns - フィルターマッピングの URL パターン
        例外:
        IllegalArgumentExceptionSE - urlPatterns が null または空の場合
        IllegalStateExceptionSE - この FilterRegistration の取得元の ServletContext がすでに初期化されている場合
      • getUrlPatternMappings

        CollectionSE<StringSE> getUrlPatternMappings()
        この FilterRegistration によって表されるフィルターの現在利用可能な URL パターンマッピングを取得します。

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

        戻り値:
        この FilterRegistration によって表されるフィルターの現在利用可能な URL パターンマッピングの(おそらく空の) Collection