RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

شیء جاوا
↳ com.android.tradefed.util.RestApiHelper

یک کلاس کمکی برای انجام فراخوانی‌های REST API.

خلاصه

ثابت‌ها

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

فیلدها

protected static final JsonFactory JSON_FACTORY

سازندگان عمومی

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

یک نمونه API helper با اطلاعات داده شده ایجاد می‌کند.

روش‌های عمومی

GenericUrl buildQueryUri (String[] uriParts, options)

با استفاده از اجزا و گزینه‌های داده شده برای URI، یک URI برای فراخوانی API بسازید.

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

یک درخواست API را اجرا می‌کند.

HttpRequestFactory getRequestFactory ()

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

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

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

ثابت‌ها

تعداد پیش‌فرض تلاش‌ها 

protected static final int DEFAULT_NUMBER_OF_RETRIES

مقدار ثابت: ۲ (۰x۰۰۰۰۰۰۲)

JSON_MIME 

protected static final String JSON_MIME

مقدار ثابت: "application/json"

فیلدها

JSON_FACTORY 

protected static final JsonFactory JSON_FACTORY

سازندگان عمومی

RestApiHelper 

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

یک نمونه API helper با اطلاعات داده شده ایجاد می‌کند.

پارامترها
requestFactory HttpRequestFactory : فاکتوری که هنگام ایجاد HttpRequest ها استفاده می‌شود.

baseUri String : آدرس پایه API

روش‌های عمومی

ساخت کوئری‌یوری 

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

پارامترها
baseUri String : آدرس پایه API

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

scopes : مجموعه‌ای از حوزه‌های OAuth که قرار است با حساب کاربری سرویس استفاده شوند

بازگشت‌ها
RestApiHelper

پرتاب‌ها
استثنای عمومی امنیت
استثنای IO