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) 建立 API 輔助執行個體，使用 Credential 進行驗證。

常數

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

公用方法

建構查詢

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

使用指定 URI 部分和選項建構 API 呼叫的 URI。uriParts 應包含 網址已編碼，但選項應為未編碼字串。

參數
uriParts	String
options

傳回
GenericUrl

執行

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

執行 API 要求。

參數
method	String：要求的 HTTP 方法
uriParts	String：網址編碼 URI 部分，用來建構要求 URI。
options	：用來建構查詢字串的未編碼參數名稱和值
data	JSONObject：要與要求一起傳送的資料

傳回
HttpResponse	HttpResponse 物件

getRequestFactory

public HttpRequestFactory getRequestFactory ()

傳回 HttpRequestFactory。

公開測試。

傳回
HttpRequestFactory

新的執行個體和 Google 認證

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

建立 API 輔助執行個體，使用 Credential 進行驗證。

參數
baseUri	String：API 的基準 URI
jsonKeyFile	File：服務帳戶 JSON 金鑰檔案
scopes	：要與服務帳戶搭配使用的 OAuth 範圍集合

傳回
RestApiHelper

擲回
	一般安全性例外狀況
	IOException