パッケージ jakarta.ws.rs

アノテーション型 ConstrainedTo


  • @TargetSE(TYPESE)
    @RetentionSE(RUNTIMESE)
    @DocumentedSE
    public @interface ConstrainedTo
    アノテーション付き JAX-RS プロバイダーが適用可能なランタイムコンテキストを示します。@ConstrainedTo アノテーションが JAX-RS プロバイダー型宣言に存在しない場合、宣言されたプロバイダーは任意のランタイムコンテキストで使用できます。このようなアノテーションが存在する場合、JAX-RS ランタイムは指定された使用制限を適用します。

    次の例は、MessageBodyReader プロバイダーの実装を JAX-RS client run-time の一部としてのみ実行するように制限することを示しています。

      @ConstrainedTo(RuntimeType.CLIENT)
      public class MyReader implements MessageBodyReader {
          ...
      }
     

    次の例は、WriterInterceptor プロバイダーの実装を JAX-RS server run-time の一部としてのみ実行するように制限することを示しています。

      @ConstrainedTo(RuntimeType.SERVER)
      public class MyWriterInterceptor implements WriterInterceptor {
          ...
      }
     

    JAX-RS プロバイダーの実装を、プロバイダーを適用できないランタイムコンテキストに制約することは構成エラーです。このような場合、JAX-RS ランタイムは課題についてユーザーに通知し、以降の処理でプロバイダーの実装を無視する必要があります。

    例: JAX-RS サーバーランタイムの一部としてのみ実行するという ClientRequestFilter の次の制限は、無効と見なされます。

      // reported as invalid and ignored by JAX-RS runtime
      @ConstrainedTo(RuntimeType.SERVER)
      public class MyFilter implements ClientRequestFilter {
          ...
      }
     
    導入:
    2.0
    作成者:
    Marek Potociar
    • 必須定数のサマリー

      必須要素  
      修飾子と型 必須要素 説明
      RuntimeTypevalue
      JAX-RS プロバイダーに配置する constraint type を定義します。
    • 要素の詳細

      • value

        RuntimeType value
        JAX-RS プロバイダーに配置する constraint type を定義します。
        戻り値:
        該当するランタイムコンテキスト。