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_RETIES
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 |
| IOException |
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 |
| IOException |