検索

付録A リファレンス資料

download PDF

A.1. JAX-RS/RESTEasy アノテーション

表A.1 JAX-RS/RESTEasy アノテーション
アノテーション使用方法

Cache

応答の Cache-Control ヘッダーを自動的に設定します。

ClientInterceptor

インターセプターをクライアント側のインターセプターとして特定します。

ContentEncoding

アノテーション付きのアノテーションで適用する Content-Encoding を指定するメタアノテーション。

Context

javax.ws.rs.core.HttpHeadersjavax.ws.rs.core.UriInfojavax.ws.rs.core.Requestjavax.servlet.HttpServletRequestjavax.servlet.HttpServletResponsejavax.ws.rs.core.SecurityContext オブジェクトのインスタンスを指定できます。

@CookieParam

HTTP リクエスト cookie のクッキーまたはオブジェクト表現の値をメソッド呼び出しに指定できます。

DecorateTypes

サポートされているタイプを指定するには、DecoratorProcessor クラスに配置する必要があります。

デコレーター

デコレーションをトリガーする別のアノテーションに配置されるメタアノテーション。

DefaultValue

HTTP リクエスト項目が存在しない場合にデフォルト値を定義するために、その他の @*Param アノテーションと組み合わせることができます。

DELETE

メソッドが HTTP DELETE リクエストに応答することを示すアノテーション。

DoNotUseJAXBProvider

このクラスまたはパラメーターは、JAXB MessageBodyReader/Writer を使用せず、代わりにタイプをマーシャリングするために使用するより具体的なプロバイダーがある場合に使用してください。

Encoded

クラス、メソッド、またはパラメーターで使用できます。デフォルトでは、@PathParam および @QueryParams はデコードされます。@Encoded アノテーションを追加すると、これらのパラメーターの値がエンコードされた形式で提供されます。

Form

これは、リクエストと要求の発信および受信を行うためにオブジェクトとして使用できます。

Formatted

インデントと改行で XML 出力をフォーマットします。これは、JAXB Decorator です。

GET

メソッドが HTTP GET リクエストに応答することを示すアノテーション。

IgnoreMediaTypes

タイプ、メソッド、パラメーター、またはフィールドにフィールドを置くと、特定のメディアタイプに対して JAX-RS プロバイダーを使用しないように指示します。

ImageWriterParams

IIOImageProvider にパラメーターを渡すためにリソースクラスが使用できるアノテーション。

Mapped

JSONConfig

MultipartForm

これは、multipart/form-data MIME タイプの受信/発進のオブジェクトとして使用できます。

NoCache

nocacheCache-Control 応答ヘッダーを設定します。

NoJackson

Jackson プロバイダーをトリガーしない場合にクラス、パラメーター、フィールド、またはメソッドに配置します。

PartType

List または Map を multipart/* タイプとして書き出す場合は、Multipart プロバイダーと併用する必要があります。

Path

これは、クラスまたはリソースメソッドに存在する必要があります。両方に存在する場合、リソースメソッドへの相対パスはクラスとメソッドの連結になります。

PathParam

変数 URI パスのフラグメントをメソッド呼び出しにマッピングできるようにします。

POST

メソッドが HTTP POST リクエストに応答することを示すアノテーション。

Priority

クラスの使用順序を示すアノテーション。値が小さい整数パラメーターを使用すると優先度が高くなります。

Provider

プロバイダースキャンフェーズで JAX-RS ランタイムによって プロバイダー として検出されるようにクラスをマークします。

PUT

メソッドが HTTP PUT リクエストに応答することを示すアノテーション。

QueryParam

URI クエリー文字列パラメーターまたは URL 形式のエンコードされたパラメーターをメソッド呼び出しにマップできるようにします。

ServerInterceptor

インターセプターをサーバー側のインターセプターとして特定します。

StringParameterUnmarshallerBinder

文字列ベースのアノテーションインジェクターに適用されるように StringParameterUnmarshaller をトリガーする別のアノテーションに配置されるメタアノテーション。

Stylesheet

XML スタイルシートヘッダーを指定します。

Wrapped

これをメソッドまたはパラメーターに配置すると、指定のオブジェクトのコレクションまたは配列をマーシャリングまたはマーシャリング解除できます。

WrappedMap

これは、JAXB オブジェクトのマップのマーシャリングまたはマーシャリング解除を行う場合は、メソッドまたはパラメーターに配置します。

XmlHeader

返されたドキュメントの XML ヘッダーを設定します。

XmlNsMap

JSONToXml

XopWithMultipartRelated

このアノテーションは、アノテーション付きのオブジェクト間の XOP メッセージの受信/送信 (multipart / 関連としてパッケージ化) の処理と生成に使用できます。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.