RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

---

כיתה מסייעת לביצוע קריאות ל-API ל-REST.

סיכום

קבועים
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) יצירת URI לקריאה ל-API עם חלקים ואפשרויות נתונים של URI.
HttpResponse	execute(String method, String[] uriParts, options, JSONObject data) הפעלת בקשת API.
HttpRequestFactory	getRequestFactory() הפונקציה מחזירה את HttpRequestFactory.
static RestApiHelper	newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, 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.
baseUri	String: ה-URI הבסיסי של ה-API

שיטות ציבוריות

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

יצירת URI לקריאה ל-API עם חלקים ואפשרויות נתונים של URI. uriParts צריכים להיות כבר בקידוד של כתובת URL, ואילו options צריכות להיות מחרוזות ללא קידוד.

פרמטרים
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	: האוסף של היקפי הרשאות OAuth לשימוש עם חשבון השירות

החזרות
RestApiHelper

זריקות
	GeneralSecurityException
	IOException