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 برای احراز هویت استفاده می کند.

ثابت ها

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 s استفاده می شود.

baseUri String : URI پایه API

روش های عمومی

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

getRequestFactory 

public HttpRequestFactory getRequestFactory ()

HttpRequestFactory را برمی گرداند.

در معرض آزمایش قرار گرفته است.

برمی گرداند
HttpRequestFactory

newInstanceWithGoogleCredential 

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

یک نمونه کمکی API ایجاد می کند که از یک Credential برای احراز هویت استفاده می کند.

پارامترها
baseUri String : URI پایه API

jsonKeyFile File : فایل کلید json حساب سرویس

scopes : مجموعه ای از محدوده های OAuth برای استفاده با حساب سرویس

برمی گرداند
RestApiHelper

پرتاب می کند
GeneralSecurityException
IOException