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

インターフェース Configuration

  • public interface Configuration
    configurable JAX-RS コンテキストに関連付けられた構成状態。構成されたコンテキストのコンポーネントと追加のメタデータを定義します。

    構成状態は、関連する JAX-RS コンテキスト（例: アプリケーション、リソースメソッドなど）またはコンポーネント（例: Client、WebTarget など）に関する構成情報を取得するために使用できます。構成情報は、プロパティ、登録された JAX-RS コンポーネントクラスおよび / またはインスタンスで構成されます。

    このインターフェースは、Context アノテーションを使用して挿入できます。

    導入:
    2.0
    作成者:
    Marek Potociar

    • 方法の概要

      すべてのメソッド   インスタンスメソッド   抽象メソッド   デフォルトメソッド  
      修飾子と型 メソッド 説明
      SetSE<ClassSE<?>>getClasses()
      登録された JAX-RS コンポーネント（プロバイダー、ルートリソース、feature など）クラスの不変のセットを取得して、構成可能なインスタンスのスコープでインスタンス化、注入、利用します。
      MapSE<ClassSE<?>,​IntegerSE>getContracts​(ClassSE<?> componentClass)
      特定のクラスのコンポーネントの延長契約登録情報を取得します。
      SetSE<ObjectSE>getInstances()
      登録された JAX-RS コンポーネント（プロバイダーや feature など）インスタンスの不変のセットを取得して、構成可能なインスタンスで使用します。
      MapSE<StringSE,​ObjectSE>getProperties()
      構成プロパティの不変のバッグを取得します。
      ObjectSEgetProperty​(StringSE name)
      指定された名前のプロパティの値を取得します。
      CollectionSE<StringSE>getPropertyNames()
      現在の構成インスタンスのコンテキスト内で使用可能なプロパティ名を含む不変の collectionSE を返します。
      RuntimeTypegetRuntimeType()
      この構成コンテキストの実行時型を取得します。
      default booleanhasProperty​(StringSE name)
      特定の名前のプロパティが構成されているかどうかを確認します。
      booleanisEnabled​(Feature feature)
      特定の feature インスタンスがランタイム構成コンテキストで以前に有効にされているかどうかを確認します。
      booleanisEnabled​(ClassSE<? extends Feature> featureClass)
      featureClass クラスの feature インスタンスがランタイム構成コンテキストで以前に有効にされているかどうかを確認します。
      booleanisRegistered​(ClassSE<?> componentClass)
      提供された componentClass クラスの JAX-RS コンポーネントが、ランタイム構成コンテキストに以前に登録されているかどうかを確認します。
      booleanisRegistered​(ObjectSE component)
      特定の JAX-RS component インスタンス（プロバイダーや features など）が以前にランタイム構成コンテキストに登録されているかどうかを確認します。

    • メソッドの詳細

      • getRuntimeType

        RuntimeType getRuntimeType()
        この構成コンテキストの実行時型を取得します。
        戻り値:
        構成コンテキストの実行時型。

      • getProperties

        MapSE<StringSE,​ObjectSE> getProperties()
        構成プロパティの不変のバッグを取得します。
        戻り値:
        構成プロパティの不変のビュー。

      • getProperty

        ObjectSE getProperty​(StringSE name)
        指定された名前のプロパティの値を取得します。
        パラメーター:
        name - プロパティ名。
        戻り値:
        指定されたプロパティ名のプロパティ値、またはそのような名前のプロパティが構成されていない場合は null。

      • hasProperty

        default boolean hasProperty​(StringSE name)
        特定の名前のプロパティが構成されているかどうかを確認します。
        パラメーター:
        name - プロパティ名。
        戻り値:
        そのような名前のプロパティが構成されていない場合は false、それ以外の場合は true。

      • isEnabled

        boolean isEnabled​(Feature feature)
        特定の feature インスタンスがランタイム構成コンテキストで以前に有効にされているかどうかを確認します。

        メソッドは、feature インスタンスと等しいインスタンスが、構成コンテキストで以前に正常に有効化された機能の中にすでに存在する場合にのみ、true を返します。

        パラメーター:
        feature - テストする機能インスタンス。
        戻り値:
        機能インスタンスがこの構成コンテキストで以前に有効になっている場合は true、それ以外の場合は false。

      • isEnabled

        boolean isEnabled​(ClassSE<? extends Feature> featureClass)
        featureClass クラスの feature インスタンスがランタイム構成コンテキストで以前に有効にされているかどうかを確認します。

        構成コンテキストで以前に正常に有効化された機能の中に featureClass クラスのインスタンスがすでに存在する場合、メソッドは true を返します。

        パラメーター:
        featureClass - テストするフィーチャクラス。
        戻り値:
        特定のクラスの機能がこの構成コンテキストで以前に有効になっている場合は true、それ以外の場合は false。

      • isRegistered

        boolean isRegistered​(ObjectSE component)
        特定の JAX-RS component インスタンス（プロバイダーや features など）が以前にランタイム構成コンテキストに登録されているかどうかを確認します。

        メソッドは、component インスタンスと等しいインスタンスが、構成コンテキストに以前に登録されたコンポーネントの中にすでに存在する場合にのみ、true を返します。

        パラメーター:
        component - テストするコンポーネントインスタンス。
        戻り値:
        コンポーネントインスタンスが以前にこの構成コンテキストに登録されている場合は true、それ以外の場合は false。
        関連事項:
        isEnabled(Feature)

      • isRegistered

        boolean isRegistered​(ClassSE<?> componentClass)
        提供された componentClass クラスの JAX-RS コンポーネントが、ランタイム構成コンテキストに以前に登録されているかどうかを確認します。

        指定された componentClass クラスのコンポーネントが、構成コンテキストで以前に登録されたコンポーネントクラスまたはインスタンスの中にすでに存在する場合、メソッドは true を返します。

        パラメーター:
        componentClass - テストするコンポーネントクラス。
        戻り値:
        特定のクラスのコンポーネントが以前にこの構成コンテキストに登録されている場合は true、それ以外の場合は false。
        関連事項:
        isEnabled(Class)

      • getContracts

        MapSE<ClassSE<?>,​IntegerSE> getContracts​(ClassSE<?> componentClass)
        特定のクラスのコンポーネントの延長契約登録情報を取得します。この構成コンテキストで構成されていないコンポーネントクラスの場合、メソッドは空の Map を返します。メソッドは null を返しません。
        パラメーター:
        componentClass - 契約を取得するコンポーネントクラス。
        戻り値:
        コンポーネントクラスが登録されている拡張契約とその優先順位のマップ。コンポーネントが実装でサポートされている拡張契約に登録されていない場合、空のマップを返すことがあります。

      • getClasses

        SetSE<ClassSE<?>> getClasses()
        登録された JAX-RS コンポーネント（プロバイダー、ルートリソース、feature など）クラスの不変のセットを取得して、構成可能なインスタンスのスコープでインスタンス化、注入、利用します。Application.getClasses() とは対照的に、このメソッドは完全なランタイムビューを返すため、自動検出されたコンポーネントも含まれます。

        コンポーネント型ごとに、構成コンテキストに存在できるクラスベースまたはインスタンスベースの登録は常に 1 つだけです。

        戻り値:
        登録された JAX-RS コンポーネントクラスの不変のセット。戻り値は空の場合がありますが、null になることはありません。
        関連事項:
        getInstances()

      • getInstances

        SetSE<ObjectSE> getInstances()
        登録された JAX-RS コンポーネント（プロバイダーや feature など）インスタンスの不変のセットを取得して、構成可能なインスタンスで使用します。返されたインスタンスのフィールドとプロパティには、使用前にランタイムによって宣言された依存関係（Context を参照）が挿入されます。

        コンポーネント型ごとに、構成コンテキストに存在できるクラスベースまたはインスタンスベースの登録は常に 1 つだけです。

        戻り値:
        登録された JAX-RS コンポーネントインスタンスの不変のセット。戻り値は空の場合がありますが、null になることはありません。
        関連事項:
        getClasses()