11.4. RESTEasy JAX-RS 固有のアノテーション

表11.1 JAX-RS/RESTEasy アノテーション

アノテーション 使用方法
@Consumes リソースクラスのメソッドあるいは MessageBodyReader が受け入れ可能なメディアタイプを定義します。
@Context クラスフィールドや Bean プロパティー、メソッドパラメーターへ情報を挿入するため使用されます。
@CookieParam HTTP クッキーの値をリソースメソッドパラメーターやリソースクラスフィールド、リソースクラス Bean プロパティーへバインドします。
@DefaultValue PathParam、QueryParam、MatrixParam、CookieParam、FormParam、HeaderParam といったアノテーションの 1 つを使用してバインドされるリクエストメタデータのデフォルト値を定義します。
@Delete アノテーションが付けられたメソッドが HTTP DELETE リクエストへ応答することを示します。
@Encoded QueryParam、PathParam、FormParam、MatrixParam のいずれかを使用してバインドしたパラメーター値の自動復号化を無効にします。
@Form RESTEasy 固有のアノテーション。@*Param アノテーションは挿入されたクラスで再使用されます。RESTEasy はクラスのインスタンス化を行い、@*Param または @Context アノテーションが付けられたプロパティーに値を挿入します。
@FormParam リクエストエンティティーボディー内に含まれるフォームパラメーターの値をリソースメソッドパラメーターにバインドします。
@GET アノテーションが付けられたメソッドが HTTP GET リクエストに応答することを示します。
@HEAD アノテーションが付けられたメソッドが HTTP HEAD リクエストに応答することを示します。
@HeaderParam リソースメソッドパラメーターやリソースクラスフィールド、リソースクラス Bean プロパティーにHTTP ヘッダーの値をバインドします。
@HttpMethod HTTP メソッド名をアノテーションに関連付けます。
@MatrixParam リソースメソッドパラメーターやリソースクラスフィールド、リソースクラスの Bean プロパティーへURI マトリックスパラメーターの値をバインドします。
@Path リソースクラスあるいはクラスメソッドがリクエストに対応する URI パスを特定します。
@PathParam URI テンプレートパラメーターの値またはテンプレートパラメーターが含まれるパスセグメントの値をリソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティーへバインドします。
@POST アノテーションが付けられたメソッドが HTTP POST リクエストに応答することを示します。
@Produces リソースクラスのメソッドあるいは MessageBodyWriter が作成可能なメディアタイプを定義します。
@Provider 拡張インターフェースの実装をマーク付けします。
@PUT アノテーションが付けられたメソッドが HTTP PUT リクエストに応答することを示します。
@QueryParam URI クエリパラメーターの値をリソースメソッドパラメーターやリソースクラスフィールド、リソースクラス Bean プロパティーへバインドします。