パッケージ jakarta.ws.rs

アノテーション型 CookieParam


  • @TargetSE({PARAMETERSE,METHODSE,FIELDSE})
    @RetentionSE(RUNTIMESE)
    @DocumentedSE
    public @interface CookieParam
    HTTP Cookie の値を、リソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。デフォルト値は、DefaultValue アノテーションを使用して指定できます。アノテーション付きパラメーター、フィールド、プロパティの型 T は、次のいずれかでなければなりません。
    1. プリミティブ型になる
    2. Cookie になる
    3. 単一の String 引数を受け入れるコンストラクターがあります
    4. 単一の文字列引数を受け入れる valueOf または fromString という名前の静的メソッドがあります (たとえば、Integer.valueOf(String)SE を参照してください)
    5. 型の「文字列から」変換が可能な ParamConverter インスタンスを返す ParamConverterProvider JAX-RS 拡張 SPI の登録済み実装があります。
    6. List<T>Set<T>SortedSet<T> または T[] 配列であり、T は 2, 3, 4 または上記の 5 を満たします。結果のコレクションは読み取り専用です。

    インジェクションはオブジェクトの作成時に発生するため、リソースクラスフィールドおよび Bean プロパティでのこのアノテーションの使用は、デフォルトのリクエストごとのリソースクラスライフサイクルでのみサポートされます。他のライフサイクルを使用するリソースクラスは、リソースメソッドパラメーターでのみこのアノテーションを使用する必要があります。

    導入:
    1.0
    作成者:
    Paul Sandoz, Marc Hadley
    関連事項:
    DefaultValue, Cookie, HttpHeaders.getCookies()
    • 必須定数のサマリー

      必須要素  
      修飾子と型 必須要素 説明
      StringSEvalue
      アノテーション付きメソッド引数、クラスフィールド、Bean プロパティの値を初期化するためにその値が使用される HTTPCookie の名前を定義します。
    • 要素の詳細

      • value

        StringSE value
        アノテーション付きメソッド引数、クラスフィールド、Bean プロパティの値を初期化するためにその値が使用される HTTPCookie の名前を定義します。
        戻り値:
        HTTPCookie 名。