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
|
String |
JSON_MIME
|
Felder | |
|---|---|
protected
static
final
JsonFactory |
JSON_FACTORY
|
Öffentliche Konstruktoren | |
|---|---|
RestApiHelper(HttpRequestFactory requestFactory, String baseUri)
Erstellt eine API-Helferinstanz mit den angegebenen Informationen. |
|
Öffentliche Methoden | |
|---|---|
GenericUrl
|
buildQueryUri(String[] uriParts, Map<String, Object> options)
Erstellt eine URI für einen API-Aufruf mit den angegebenen URI-Teilen und Optionen. |
HttpResponse
|
execute(String method, String[] uriParts, Map<String, Object> options, JSONObject data)
Führt eine API-Anfrage aus. |
HttpRequestFactory
|
getRequestFactory()
Gibt die HttpRequestFactory zurück. |
static
RestApiHelper
|
newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, Collection<String> scopes)
Erstellt eine API-Helferinstanz, die ein |
Konstanten
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Constant Value: 2 (0x00000002)
JSON_MIME
protected static final String JSON_MIME
Constant Value: "application/json"
Felder
JSON_FACTORY
protected static final JsonFactory JSON_FACTORY
Öffentliche Konstruktoren
RestApiHelper
public RestApiHelper (HttpRequestFactory requestFactory,
String baseUri)Erstellt eine API-Helferinstanz mit den angegebenen Informationen.
| Parameter | |
|---|---|
requestFactory |
HttpRequestFactory: die Factory, die beim Erstellen von HttpRequests verwendet werden soll. |
baseUri |
String: Die Basis-URI der API. |
Öffentliche Methoden
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,
Map<String, Object> options)Erstellt eine URI für einen API-Aufruf mit den angegebenen URI-Teilen und Optionen. Die URI-Teile sollten bereits URL-codiert sein, während die Optionen nicht codierte Strings sein sollten.
| Parameter | |
|---|---|
uriParts |
String |
options |
Map |
| Gibt Folgendes zurück: | |
|---|---|
GenericUrl |
|
execute
public HttpResponse execute (String method,
String[] uriParts,
Map<String, Object> 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 der Anfrage-URI verwendet werden. |
options |
Map: Nicht codierte Parameternamen und -werte, die zum Erstellen der Abfragestring verwendet werden. |
data |
JSONObject: Daten, die mit der Anfrage gesendet werden sollen. |
| Gibt Folgendes zurück: | |
|---|---|
HttpResponse |
Ein HttpResponse-Objekt. |
| Löst aus | |
|---|---|
IOException |
|
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Gibt die HttpRequestFactory zurück.
Für Tests verfügbar gemacht.
| Gibt Folgendes zurück: | |
|---|---|
HttpRequestFactory |
|
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, Collection<String> scopes)
Erstellt eine API-Helferinstanz, die ein Credential zur Authentifizierung verwendet.
| Parameter | |
|---|---|
baseUri |
String: Die Basis-URI der API. |
jsonKeyFile |
File: Die JSON-Schlüsseldatei des Dienstkontos. |
scopes |
Collection: Die Sammlung von OAuth-Bereichen, die mit dem Dienstkonto verwendet werden sollen. |
| Gibt Folgendes zurück: | |
|---|---|
RestApiHelper |
|
| Löst aus | |
|---|---|
|
java.io.IOException |
|
java.security.GeneralSecurityException |
GeneralSecurityException |
|
IOException |
|