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) buildQueryUri (String[] uriParts, options)

使用給定的 URI 部分和選項為 API 調用構造 URI。

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

執行 API 請求。

HttpRequestFactory getRequestFactory ()

返回 HttpRequestFactory。

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

創建一個 API 幫助程序實例，它使用Credential進行身份驗證。

static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)

創建一個 API 幫助程序實例，它使用Credential進行身份驗證。

常量

默認_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

常量值：2 (0x00000002)

領域

JSON_工廠

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

執行

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

執行 API 請求。

參數
method String : 請求的 HTTP 方法

uriParts String ：用於構造請求 URI 的 URL 編碼 URI 部分。

options ：用於構造查詢字符串的未編碼參數名稱和值

data JSONObject ：要隨請求一起發送的數據

退貨
HttpResponse一個 HttpResponse 對象

獲取請求工廠

public HttpRequestFactory getRequestFactory ()

返回 HttpRequestFactory。

暴露測試。

退貨
HttpRequestFactory

newInstanceWithGoogleCredential

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

創建一個 API 幫助程序實例，它使用Credential進行身份驗證。

參數
baseUri String : API 的基本 URI

jsonKeyFile File ：服務賬戶 json 密鑰文件

scopes ：與服務帳戶一起使用的 OAuth 範圍的集合

退貨
RestApiHelper

投擲
一般安全異常
異常

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                String serviceAccount, 
                File keyFile, 
                 scopes)

創建一個 API 幫助程序實例，它使用Credential進行身份驗證。

參數
baseUri String : API 的基本 URI

serviceAccount String ：要使用的服務帳戶的名稱

keyFile File ：服務帳戶密鑰文件

scopes ：與服務帳戶一起使用的 OAuth 範圍的集合

退貨
RestApiHelper

投擲
一般安全異常
異常