RestApiHelper
public
class
RestApiHelper
extends Object
implements
IRestApiHelper
| java.lang.Object | |
| ↳ | com.android.tradefed.util.RestApiHelper |
Eine Hilfsklasse zum Ausführen von REST API-Aufrufen.
Zusammenfassung
Konstanten | |
|---|---|
int |
DEFAULT_NUMBER_OF_RETRIES
|
Felder | |
|---|---|
protected
static
final
JsonFactory |
JSON_FACTORY
|
protected
static
final
String |
JSON_MIME
|
Öffentliche Konstruktoren | |
|---|---|
RestApiHelper(HttpRequestFactory requestFactory, String baseUri)
Erstellt eine API-Hilfsinstanz mit den angegebenen Informationen. |
|
Öffentliche Methoden | |
|---|---|
GenericUrl
|
buildQueryUri(String[] uriParts,
Erstellen Sie einen URI für einen API-Aufruf mit den angegebenen URI-Teilen und -Optionen. |
HttpResponse
|
execute(String method, String[] uriParts,
Führt eine API-Anfrage aus. |
HttpRequestFactory
|
getRequestFactory()
Gibt die HttpRequestFactory zurück. |
static
RestApiHelper
|
newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile,
Erstellt eine API-Hilfeinstanz, die für die Authentifizierung einen |
Konstanten
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Konstanter Wert: 2 (0x00000002)
Felder
JSON_FACTORY
protected static final JsonFactory JSON_FACTORY
JSON_MIME
protected static final String JSON_MIME
Öffentliche Konstruktoren
RestApiHelper
public RestApiHelper (HttpRequestFactory requestFactory,
String baseUri)Erstellt eine API-Hilfsinstanz mit den angegebenen Informationen.
| Parameter | |
|---|---|
requestFactory |
HttpRequestFactory: Die Fabrikmethode, die beim Erstellen von HttpRequests verwendet werden soll. |
baseUri |
String: der Basis-URI der API |
Öffentliche Methoden
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,
options) Erstelle einen URI für einen API-Aufruf mit den angegebenen URI-Teilen und Optionen. uriParts sollte bereits URL-codiert sein, während Optionen unverschlüsselte Strings sein sollten.
| Parameter | |
|---|---|
uriParts |
String |
options |
|
| Returns | |
|---|---|
GenericUrl |
|
execute
public HttpResponse execute (String method,
String[] uriParts,
options,
JSONObject data) Führt eine API-Anfrage aus.
| Parameter | |
|---|---|
method |
String: eine HTTP-Methode der Anfrage |
uriParts |
String: URL-codierte URI-Teile, die zum Erstellen des Anfrage-URI verwendet werden. |
options |
: nicht codierte Parameternamen und ‑werte, die zum Erstellen des Abfragestrings verwendet werden |
data |
JSONObject: Daten, die mit der Anfrage gesendet werden |
| Returns | |
|---|---|
HttpResponse |
ein HttpResponse-Objekt |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Gibt die HttpRequestFactory zurück.
Wird für Tests freigegeben.
| Returns | |
|---|---|
HttpRequestFactory |
|
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Erstellt eine API-Hilfeinstanz, die für die Authentifizierung einen Credential verwendet.
| Parameter | |
|---|---|
baseUri |
String: der Basis-URI der API |
jsonKeyFile |
File: die JSON-Schlüsseldatei des Dienstkontos |
scopes |
: die OAuth-Bereiche, die mit dem Dienstkonto verwendet werden sollen |
| Returns | |
|---|---|
RestApiHelper |
|
| Ausgabe | |
|---|---|
|
GeneralSecurityException |
|
IOException |