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

インターフェース DynamicFeature

  • public interface DynamicFeature
    デプロイ時に JAX-RS アプリケーションのセットアップ中にマッチング後のプロバイダーを動的に登録するための JAX-RS メタプロバイダー。動的機能は、JAX-RS ランタイムによって使用され、特定のリソースクラスおよびメソッドに適用されるプロバイダーを登録し、登録されたリソースフィルターまたはインターセプターインスタンスで定義されたアノテーションベースのバインディング定義をオーバーライドします。

    このインターフェースを実装するプロバイダーは、リソースとプロバイダーをスキャンするときに JAX-RS ランタイムによって検出されるように、@Provider アノテーションでアノテーションを付けることができます。このプロバイダー型は、サーバー API の一部としてのみサポートされます。

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

    • メソッドの詳細

      • configure

        void configure​(ResourceInfo resourceInfo,
               FeatureContext context)
        特定の resource or sub-resource method の runtime configuration スコープにプロバイダーインスタンスまたはクラスを登録するために、アプリケーションデプロイ中に JAX-RS ランタイムによって呼び出されるコールバックメソッド。つまり、メソッドに動的にバインドする必要があるプロバイダー。

        登録されたプロバイダーインスタンスまたはクラスは、次のインターフェースの 1 つ以上を実装していることが期待されます。

        上記のインターフェースのいずれも実装していないプロバイダーインスタンスまたはクラスは、JAX-RS 実装によって無視される場合があります。このような場合、warningSE メッセージをログに記録する必要があります。JAX-RS 実装は、動的機能の概念を使用して登録できる追加のプロバイダー契約をサポートする場合があります。

        概念的には、このコールバックメソッドは resource or sub-resource method 検出フェーズ中に呼び出され（通常、検出されたリソースまたはサブリソースメソッドごとに 1 回）、提供された resource information によって識別される特定の各メソッドの configuration スコープにプロバイダーインスタンスまたはクラスを登録します。この機能の責任は、提供された configuration コンテキストを適切に更新することです。

        パラメーター:
        resourceInfo - リソースクラスとメソッドの情報。
        context - 機能が含まれる resourceInfo に関連付けられた構成可能なリソースまたはサブリソースのメソッドレベルのランタイムコンテキスト