RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
   ↳ com.android.tradefed.util.RestApiHelper

فئة مساعدة لتنفيذ طلبات البيانات من واجهة برمجة تطبيقات REST

ملخّص

الثوابت

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

الحقول

protected static final JsonFactory JSON_FACTORY

الإنشاءات العامة

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

تنشئ هذه الدالة مثيلاً لمساعد واجهة برمجة التطبيقات باستخدام المعلومات المقدَّمة.

الطُرق العامة

GenericUrl buildQueryUri(String[] uriParts, options)

إنشاء معرّف موارد منتظم (URI) لطلب بيانات من واجهة برمجة التطبيقات باستخدام أجزاء وخيارات معرّف الموارد المنتظم (URI) المحدّدة

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

تنفيذ طلب بيانات من واجهة برمجة التطبيقات

HttpRequestFactory getRequestFactory()

تعرض هذه الدالة HttpRequestFactory.

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

تنشئ هذه السمة مثيلاً لمساعد واجهة برمجة التطبيقات يستخدم Credential للمصادقة.

الثوابت

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Constant Value: 2 (0x00000002)

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)

تنشئ هذه الدالة مثيلاً لمساعد واجهة برمجة التطبيقات باستخدام المعلومات المقدَّمة.

المعلمات
requestFactory ‫HttpRequestFactory: المصنع الذي سيتم استخدامه عند إنشاء HttpRequest.
baseUri ‫String: معرّف الموارد المنتظم الأساسي لواجهة برمجة التطبيقات

الطُرق العامة

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

إنشاء معرّف URI لطلب بيانات من واجهة برمجة التطبيقات باستخدام أجزاء ومعلمات معرّف URI المحدّدة، ويجب أن تكون أجزاء معرّف URI مرمَّزة مسبقًا، بينما يجب أن تكون المعلمات سلاسل غير مرمَّزة

المعلمات
uriParts String

options

المرتجعات
GenericUrl

تنفيذ

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

تنفيذ طلب بيانات من واجهة برمجة التطبيقات

المعلمات
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)

تنشئ هذه السمة مثيلاً لمساعد واجهة برمجة التطبيقات يستخدم Credential للمصادقة.

المعلمات
baseUri ‫String: معرّف الموارد المنتظم (URI) الأساسي لواجهة برمجة التطبيقات
jsonKeyFile File: ملف مفتاح json لحساب الخدمة
scopes : مجموعة نطاقات OAuth التي سيتم استخدامها مع حساب الخدمة
المرتجعات
RestApiHelper

الرميات
GeneralSecurityException
IOException