パッケージ jakarta.ws.rs.container

インターフェース ContainerResponseFilter

  • public interface ContainerResponseFilter
    コンテナーレスポンスフィルターによって実装される拡張インターフェース。

    デフォルトでは、つまり、name binding がフィルター実装クラスに適用されていない場合、フィルターインスタンスはすべての発信レスポンスにグローバルに適用されます。フィルターに @NameBinding アノテーションが適用されている場合、フィルターは、リクエストが resource or sub-resource method に一致し、メソッドまたはカスタム JAX-RS Application クラス全体が同じ名前バインディングアノテーションにバインドされているレスポンスに対してのみ実行されます。

    フィルター機能を一致するリソースまたはリソースメソッドに制限する場合は、名前にバインドされたレスポンスフィルターを実装します。その他の場合、フィルターを発信レスポンスにグローバルに適用する必要がある場合は、バインドされていないグローバルレスポンスフィルターを実装します。

    このインターフェースを実装するフィルターは、JAX-RS ランタイムによって検出されるように @Provider でアノテーションを付ける必要があります。コンテナーレスポンスフィルターインスタンスも検出され、dynamically が特定のリソースメソッドにバインドされる場合があります。

    導入:
    2.0
    作成者:
    Marek Potociar, Santiago Pericas-Geertsen
    関連事項:
    ContainerRequestFilter

    • メソッドの詳細

      • filter

        void filter​(ContainerRequestContext requestContext,
            ContainerResponseContext responseContext)
     throws IOExceptionSE
        リクエストに対してレスポンスが提供された後に呼び出されるフィルターメソッド（request filter または一致するリソースメソッドのいずれかによる）。

        フィルターチェーンのフィルターは、jakarta.annotation.Priority クラスレベルのアノテーション値に従って順序付けられます。

        パラメーター:
        requestContext - リクエストコンテキスト。
        responseContext - レスポンスコンテキスト。
        例外:
        IOExceptionSE - I/O 例外が発生した場合。