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 s.

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

الأساليب العامة

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 : أجزاء URI المشفرة لعنوان 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 الأساسي لواجهة برمجة التطبيقات

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

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

عائدات
RestApiHelper

رميات
استثناءات الأمن العام
IOException

newInstanceWithGoogleCredential

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

ينشئ مثيل API المساعد الذي يستخدم Credential للمصادقة.

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

serviceAccount String : اسم حساب الخدمة المراد استخدامه

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

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

عائدات
RestApiHelper

رميات
استثناءات الأمن العام
IOException