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 برای احراز هویت.

ثابت ها

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 : از 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 : 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

newInstanceWithGoogleCredential

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

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

مولفه های
baseUri String : URI را پایه API

serviceAccount String : نام سرویس حساب برای استفاده از

keyFile File : حساب خدمات فایل کلید

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

برمی گردد
RestApiHelper

پرتاب می کند
GeneralSecurityException