Red Hat Training
A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform
15.4. RESTEasy で定義された注釈
表15.1 JAX-RS/RESTEasy アノテーション
| アノテーション | 用途 |
|---|---|
ClientResponseType | これは、応答タイプが返される RESTEasy クライアントインターフェイスに追加できる注釈です。 |
ContentEncoding | アノテーション付きのアノテーションで適用する Content-Encoding を指定するメタアノテーション。 |
DecorateTypes | サポートされているタイプを指定するには、DecoratorProcessor クラスに配置する必要があります。 |
Decorator | デコレーションをトリガーする別のアノテーションに配置されるメタアノテーション。 |
Form | これは、リクエストと要求の発信および受信を行うためにオブジェクトとして使用できます。 |
StringParameterUnmarshallerBinder | 文字列ベースのアノテーションインジェクターに適用されるように StringParameterUnmarshaller をトリガーする別のアノテーションに配置されるメタアノテーション。 |
Cache | 応答の Cache-Control ヘッダーを自動的に設定します。 |
NoCache | nocache の Cache-Control 応答ヘッダーを設定します。 |
ServerCached | この jax-rs メソッドへの応答をサーバーにキャッシュする必要があることを指定します。 |
ClientInterceptor | インターセプターをクライアント側のインターセプターとして特定します。 |
DecoderPrecedence | このインターセプターは、コンテンツエンコーディングデコーダーです。 |
EncoderPrecedence | このインターセプターは、コンテンツエンコーディングエンコーダーです。 |
HeaderDecoratorPrecedence | HeaderDecoratorPrecedence インターセプターは、応答 (サーバー上) または送信要求 (クライアント上) を特別なユーザー定義のヘッダーで装飾するため、常に最初に来る必要があります。 |
RedirectPrecedence | PreProcessInterceptor に配置する必要があります。 |
SecurityPrecedence | PreProcessInterceptor に配置する必要があります。 |
ServerInterceptor | インターセプターをサーバー側のインターセプターとして特定します。 |
NoJackson | Jackson プロバイダーをトリガーしない場合にクラス、パラメーター、フィールド、またはメソッドに配置します。 |
ImageWriterParams | IIOImageProvider にパラメーターを渡すためにリソースクラスが使用できるアノテーション。 |
DoNotUseJAXBProvider | このクラスまたはパラメーターは、JAXB MessageBodyReader/Writer を使用せず、代わりにタイプをマーシャリングするために使用するより具体的なプロバイダーがある場合に使用してください。 |
Formatted | インデントと改行で XML 出力をフォーマットします。これは、JAXB Decorator です。 |
IgnoreMediaTypes | タイプ、メソッド、パラメーター、またはフィールドにフィールドを置くと、特定のメディアタイプに対して JAXRS プロバイダーを使用しないように指示します。 |
Stylesheet | XML スタイルシートヘッダーを指定します。 |
Wrapped | これをメソッドまたはパラメーターに配置すると、指定のオブジェクトのコレクションまたは配列をマーシャリングまたはマーシャリング解除できます。 |
WrappedMap | これは、JAXB オブジェクトのマップのマーシャリングまたはマーシャリング解除を行う場合は、メソッドまたはパラメーターに配置します。 |
XmlHeader | 返されたドキュメントの XML ヘッダーを設定します。 |
BadgerFish | A JSONConfig. |
Mapped | A JSONConfig. |
XmlNsMap | A JSONToXml. |
MultipartForm | これは、multipart/form-data mime タイプの受信/発進のオブジェクトとして使用できます。 |
PartType | List または Map を multipart/* タイプとして書き出す場合は、Multipart プロバイダーと併用する必要があります。 |
XopWithMultipartRelated | このアノテーションは、アノテーション付きのオブジェクト間の XOP メッセージの受信/送信 (multipart / 関連としてパッケージ化) の処理と生成に使用できます。 |
After | 署名時に有効期限属性を追加するため、または検証のための古いチェックとして使用されます。 |
Signed | DOSETA 仕様を使用して要求または応答の署名をトリガーするコンビニエンスアノテーション。 |
Verify | 署名ヘッダーで指定された入力署名の検証。 |
Path | これは、クラスまたはリソースメソッドに存在する必要があります。両方に存在する場合、リソースメソッドへの相対パスはクラスとメソッドの連結になります。 |
PathParam | 変数 URI パスのフラグメントをメソッド呼び出しにマッピングできるようにします。 |
QueryParam | URI クエリー文字列パラメーターまたは URL 形式のエンコードされたパラメーターをメソッド呼び出しにマップできるようにします。 |
CookieParam | HTTP リクエスト cookie のクッキーまたはオブジェクト表現の値をメソッド呼び出しに指定できます。 |
DefaultValue | HTTP リクエスト項目が存在しない場合にデフォルト値を定義するために、その他の @*Param アノテーションと組み合わせることができます。 |
Context | javax.ws.rs.core.HttpHeaders、javax.ws.rs.core.UriInfo、javax.ws.rs.core.Request、javax.servlet.HttpServletRequest、javax.servlet.HttpServletResponse、javax.ws.rs.core.SecurityContext オブジェクトのインスタンスを指定できます。 |
Encoded | クラス、メソッド、またはパラメーターで使用できます。デフォルトでは、@PathParam および @QueryParams はデコードされます。@Encoded アノテーションを追加すると、これらのパラメーターの値がエンコードされた形式で提供されます。 |
