RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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


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

ملخّص

الثابتات

int DEFAULT_NUMBER_OF_RETRIES

الحقول

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

وظائف الإنشاء العامة

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

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

الطرق العامة

GenericUrl buildQueryUri(String[] uriParts, options)

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

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

القيمة الثابتة: 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)

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

المعلمات
requestFactory HttpRequestFactory: المصنع الذي سيتم استخدامه عند إنشاء HttpRequest

baseUri String: معرّف الموارد المنتظم الأساسي لواجهة برمجة التطبيقات

الطرق العامة

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

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

المعلمات
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: معرّف الموارد المنتظم الأساسي لواجهة برمجة التطبيقات

jsonKeyFile File: ملف مفتاح json لحساب الخدمة

scopes : مجموعة نطاقات OAuth لاستخدامها مع حساب الخدمة

المرتجعات
RestApiHelper

عمليات الرمي
GeneralSecurityException
IOException