付録A リファレンス資料
A.1. JAX-RS/RESTEasy アノテーション
表A.1 JAX-RS/RESTEasy アノテーション
アノテーション | 使用方法 |
---|---|
Cache |
応答の |
ClientInterceptor | インターセプターをクライアント側のインターセプターとして特定します。 |
ContentEncoding |
アノテーション付きのアノテーションで適用する |
Context |
|
@CookieParam | HTTP リクエスト cookie のクッキーまたはオブジェクト表現の値をメソッド呼び出しに指定できます。 |
DecorateTypes |
サポートされているタイプを指定するには、 |
デコレーター | デコレーションをトリガーする別のアノテーションに配置されるメタアノテーション。 |
DefaultValue |
HTTP リクエスト項目が存在しない場合にデフォルト値を定義するために、その他の |
DELETE |
メソッドが HTTP |
DoNotUseJAXBProvider |
このクラスまたはパラメーターは、JAXB |
Encoded |
クラス、メソッド、またはパラメーターで使用できます。デフォルトでは、 |
Form | これは、リクエストと要求の発信および受信を行うためにオブジェクトとして使用できます。 |
Formatted | インデントと改行で XML 出力をフォーマットします。これは、JAXB Decorator です。 |
GET |
メソッドが HTTP |
IgnoreMediaTypes | タイプ、メソッド、パラメーター、またはフィールドにフィールドを置くと、特定のメディアタイプに対して JAX-RS プロバイダーを使用しないように指示します。 |
ImageWriterParams |
|
Mapped |
|
MultipartForm | これは、multipart/form-data MIME タイプの受信/発進のオブジェクトとして使用できます。 |
NoCache |
|
NoJackson | Jackson プロバイダーをトリガーしない場合にクラス、パラメーター、フィールド、またはメソッドに配置します。 |
PartType |
List または Map を |
Path | これは、クラスまたはリソースメソッドに存在する必要があります。両方に存在する場合、リソースメソッドへの相対パスはクラスとメソッドの連結になります。 |
PathParam | 変数 URI パスのフラグメントをメソッド呼び出しにマッピングできるようにします。 |
POST |
メソッドが HTTP |
Priority | クラスの使用順序を示すアノテーション。値が小さい整数パラメーターを使用すると優先度が高くなります。 |
Provider | プロバイダースキャンフェーズで JAX-RS ランタイムによって プロバイダー として検出されるようにクラスをマークします。 |
PUT |
メソッドが HTTP |
QueryParam | URI クエリー文字列パラメーターまたは URL 形式のエンコードされたパラメーターをメソッド呼び出しにマップできるようにします。 |
ServerInterceptor | インターセプターをサーバー側のインターセプターとして特定します。 |
StringParameterUnmarshallerBinder |
文字列ベースのアノテーションインジェクターに適用されるように |
Stylesheet | XML スタイルシートヘッダーを指定します。 |
Wrapped | これをメソッドまたはパラメーターに配置すると、指定のオブジェクトのコレクションまたは配列をマーシャリングまたはマーシャリング解除できます。 |
WrappedMap | これは、JAXB オブジェクトのマップのマーシャリングまたはマーシャリング解除を行う場合は、メソッドまたはパラメーターに配置します。 |
XmlHeader | 返されたドキュメントの XML ヘッダーを設定します。 |
XmlNsMap |
|
XopWithMultipartRelated | このアノテーションは、アノテーション付きのオブジェクト間の XOP メッセージの受信/送信 (multipart / 関連としてパッケージ化) の処理と生成に使用できます。 |