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) والذي يستخدم |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) ينشئ مثيلًا مساعدًا لواجهة برمجة التطبيقات (API) والذي يستخدم |
الثوابت
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 الأساسي لواجهة برمجة التطبيقات (API). |
الأساليب العامة
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 الأساسي لواجهة برمجة التطبيقات (API). |
jsonKeyFile | File : ملف مفتاح حساب الخدمة json |
scopes |
عائدات | |
---|---|
RestApiHelper |
رميات | |
---|---|
| GeneralSecurityException |
| IOEException |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
ينشئ مثيلًا مساعدًا لواجهة برمجة التطبيقات (API) والذي يستخدم Credential
للمصادقة.
حدود | |
---|---|
baseUri | String : عنوان URI الأساسي لواجهة برمجة التطبيقات (API). |
serviceAccount | String : اسم حساب الخدمة المراد استخدامه |
keyFile | File : ملف مفتاح حساب الخدمة |
scopes |
عائدات | |
---|---|
RestApiHelper |
رميات | |
---|---|
| GeneralSecurityException |
| IOEException |