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

インターフェース Feature

public interface Feature
機能拡張契約。通常、複数のプロバイダー（フィルターやインターセプターなど）やプロパティの構成を含む概念または機能をカプセル化します。

Feature は、特別な型の JAX-RS 構成メタプロバイダーです。機能が登録されると、その configure(FeatureContext) メソッドが JAX-RS ランタイム構成およびブートストラップフェーズ中に呼び出され、機能が登録されているランタイムコンテキストをさらに構成できるようになります。呼び出された configure(...) メソッド内から、機能は、ネストされた機能を含む追加の契約プロバイダーの登録やドメイン固有のプロパティの指定など、それが表すファシリティまたは概念ドメインの追加のランタイム構成を提供できます。

このインターフェースを実装する機能は、リソースとプロバイダーをスキャンするときに JAX-RS ランタイムによって検出されるように、@Provider アノテーションでアノテーションを付けることができます。これはサーバー側の機能でのみ機能することに注意してください。JAX-RS クライアントの機能はプログラムで登録する必要があります。

導入:
2.0
作成者:
Marek Potociar

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    boolean
    configure(FeatureContext context)
    特定のランタイム構成スコープで機能を有効にするときに呼び出されるコールバックメソッド。

  • メソッドの詳細

    • configure

      boolean configure(FeatureContext context)
      特定のランタイム構成スコープで機能を有効にするときに呼び出されるコールバックメソッド。この機能の責任は、提供されたランタイム構成コンテキストを適切に更新し、機能が正常に有効化された場合は true を返し、それ以外の場合は false を返すことです。

      状況によっては、機能がそれ自体を有効にしないことを決定する場合があることに注意してください。これは、false を返すことで示されます。このような場合、構成コンテキストは有効な機能のコレクションに機能を追加せず、その後 Configuration.isEnabled(Feature) または Configuration.isEnabled(Class) メソッドを呼び出すと false が返されます。

      パラメーター:
      context - 機能を有効にする必要がある構成可能なコンテキスト。
      戻り値:
      機能が正常に有効化された場合は true、それ以外の場合は false。