11.12.4. JavaScript API を用いた AJAX クエリの構築
概要
RESTEasy JavaScript API を手作業で使用してリクエストを構築することができます。このトピックではこの動作の例について取り上げます。
例11.16 REST オブジェクト
REST オブジェクトを使用して RESTEasy JavaScript API のクライアントの挙動を上書きすることができます。
REST オブジェクトには次の読み書きプロパティーが含まれています。
- apiURL
- デフォルトで JAX-RS ルート URL に設定されます。リクエストを構築する時にすべての JavaScript クライアント API 関数によって使用されます。
- log
- RESTEasy クライアント API のログを受信するため function(string) に設定されます。クライアント API をデバッグし、見える場所にログを置きたい場合に便利です。
例11.17 REST.Request クラス
REST.Request クラスを使用してカスタムリクエストを構築することができます。
REST.Request クラスには次のメソッドがあります。
- execute(callback)
- 現在のオブジェクトに設定されたすべての情報を持つリクエストを実行します。値が返されることはありませんが、任意の引数コールバックへ渡されます。
- setAccepts(acceptHeader)
- Accept リクエストヘッダーを設定します。デフォルト値は */* です。
- setCredentials(username, password)
- リクエストの認証情報を設定します。
- setEntity(entity)
- リクエストエンティティーを設定します。
- setContentType(contentTypeHeader)
- Content-Type リクエストヘッダーを設定します。
- setURI(uri)
- リクエスト URI を設定します。絶対 URI でなければなりません。
- setMethod(method)
- リクエストメソッドを設定します。デフォルト値は GET です。
- setAsync(async)
- ブール変数です。リクエストが非同期であるべきかどうかを制御します。デフォルト値は true です。
- addCookie(name, value)
- リクエストを実行する時に現在のドキュメントに特定のクッキーを設定します。これはブラウザーで永続化されます。
- addQueryParameter(name, value)
- クエリパラメーターを URI のクエリ部分に追加します。
- addMatrixParameter(name, value)
- リクエスト URI の最後のパスセグメントへマトリックスパラメーター (パスパラメーター) を追加します。
- addHeader(name, value)
- リクエストヘッダーを追加します。