RestApiHelper
public class RestApiHelper
extends Object
implements IRestApiHelper
对象 | |
↳ | 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帮助程序实例 |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) 创建它使用的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 |
公共方法
构建查询Uri
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 :URL编码中使用URI部件构造请求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 |
退货 | |
---|---|
RestApiHelper |
投掷 | |
---|---|
| 一般安全异常 |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
创建它使用的API帮助程序实例Credential
进行认证。
参数 | |
---|---|
baseUri | String :API的基本URI |
serviceAccount | String :该服务的名称帐户使用 |
keyFile | File :服务帐户密钥文件 |
scopes |
退货 | |
---|---|
RestApiHelper |
投掷 | |
---|---|
| 一般安全异常 |