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, Map<String, Object> options)

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

HttpResponse execute(String method, String[] uriParts, Map<String, Object> options, JSONObject data)

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

HttpRequestFactory getRequestFactory()

عرض HttpRequestFactory

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, Collection<String> 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

Constant Value: "application/json"

الحقول

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

طُرق وضع التصميم العامة

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

إنشاء مثيل لمساعد واجهة برمجة التطبيقات بالمعلومات المقدَّمة

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

الإجراءات العامة

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                Map<String, Object> options)

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

المعلَمات
uriParts String

options Map

المرتجعات
GenericUrl

execute

public HttpResponse execute (String method, 
                String[] uriParts, 
                Map<String, Object> options, 
                JSONObject data)

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

المعلَمات
method String: طريقة HTTP للطلب
uriParts String: أجزاء عنوان URI المُرمَّزة باستخدام ترميز عنوان URL والتي سيتم استخدامها لإنشاء عنوان URI للطلب
options Map: أسماء المعلَمات وقيمها غير المُرمَّزة التي تُستخدم لإنشاء سلسلة طلب البحث
data JSONObject: البيانات التي سيتم إرسالها مع الطلب
المرتجعات
HttpResponse كائن HttpResponse
عمليات الطرح
IOException

getRequestFactory

public HttpRequestFactory getRequestFactory ()

عرض HttpRequestFactory

يتم عرضه للاختبار.

المرتجعات
HttpRequestFactory

newInstanceWithGoogleCredential

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

إنشاء مثيل لمساعد واجهة برمجة التطبيقات يستخدم Credential للمصادقة

المعلَمات
baseUri String: عنوان URI الأساسي لواجهة برمجة التطبيقات
jsonKeyFile File: ملف مفتاح JSON لحساب الخدمة
scopes Collection: مجموعة نطاقات OAuth التي سيتم استخدامها مع حساب الخدمة
المرتجعات
RestApiHelper

عمليات الطرح
java.io.IOException
java.security.GeneralSecurityException
GeneralSecurityException
IOException