RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
   ↳ com.android.tradefed.util.RestApiHelper

REST API 呼び出しを実行するためのヘルパークラス。

概要

定数

int DEFAULT_NUMBER_OF_RETRIES

フィールド

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

パブリック コンストラクタ

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

指定された情報で API ヘルパー インスタンスを作成します。

パブリック メソッド

GenericUrl buildQueryUri(String[] uriParts, options)

指定された URI 部分とオプションを使用して API 呼び出しの URI を作成します。

HttpResponse execute(String method, String[] uriParts, options, JSONObject data)

API リクエストを実行します。

HttpRequestFactory getRequestFactory()

HttpRequestFactory を返します。

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, scopes)

認証に Credential を使用する API ヘルパー インスタンスを作成します。

定数

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

定数値: 2 （0x00000002）

フィールド

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

パブリック コンストラクタ

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

指定された情報で API ヘルパー インスタンスを作成します。

パラメータ
requestFactory HttpRequestFactory: HttpRequest の作成時に使用するファクトリ。
baseUri String: API のベース URI

パブリック メソッド

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

指定された URI 部分とオプションを使用して API 呼び出しの URI を作成します。uriParts を すでに URL エンコードされていますが、オプションにはエンコードされていない文字列を指定する必要があります。

パラメータ
uriParts String

options

戻り値
GenericUrl

execute

public HttpResponse execute (String method, 
                String[] uriParts, 
                 options, 
                JSONObject data)

API リクエストを実行します。

パラメータ
method String: リクエストの HTTP メソッド
uriParts String: リクエスト URI の作成に使用する、URL エンコードされた URI 部分。
options : クエリ文字列の作成に使用される、エンコードされていないパラメータの名前と値
data JSONObject: リクエストで送信されるデータ
戻り値
HttpResponse HttpResponse オブジェクト

getRequestFactory

public HttpRequestFactory getRequestFactory ()

HttpRequestFactory を返します。

テスト用に公開されています。

戻り値
HttpRequestFactory

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 scopes)

認証に Credential を使用する API ヘルパー インスタンスを作成します。

パラメータ
baseUri String: API のベース URI
jsonKeyFile File: サービス アカウント JSON キーファイル
scopes : サービス アカウントで使用する OAuth スコープのコレクション
戻り値
RestApiHelper

例外
GeneralSecurityException（一般セキュリティ例外）
IOException