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,
Erstellt einen URI für einen API-Aufruf mit bestimmten 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-Hilfsinstanz, die eine |
Konstanten
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Konstantenwert: 2. (0x00000002)
Felder
JSON_FERTIG
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 Factory, die beim Erstellen von HttpRequest s verwendet wird. |
baseUri |
String : Basis-URI der API |
Öffentliche Methoden
buildQueryUri (AbfrageUri)
public GenericUrl buildQueryUri (String[] uriParts,options)
Erstellt einen URI für einen API-Aufruf mit bestimmten URI-Teilen und -Optionen. uriParts sollte URL-codiert, Optionen sollten nicht codierte Strings sein.
Parameter | |
---|---|
uriParts |
String |
options |
|
Returns | |
---|---|
GenericUrl |
ausführen
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 sollen. |
options |
: nicht codierte Parameternamen und -werte, die zum Erstellen des Abfragestrings verwendet werden |
data |
JSONObject : Daten, die mit der Anfrage gesendet werden sollen |
Returns | |
---|---|
HttpResponse |
ein HttpResponse-Objekt |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Gibt die HttpRequestFactory zurück.
Wird zu Testzwecken zur Verfügung gestellt.
Returns | |
---|---|
HttpRequestFactory |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Erstellt eine API-Hilfsinstanz, die eine Credential
für die Authentifizierung verwendet.
Parameter | |
---|---|
baseUri |
String : der Basis-URI der API |
jsonKeyFile |
File : die JSON-Schlüsseldatei des Dienstkontos |
scopes |
: die Sammlung von OAuth-Bereichen, die mit dem Dienstkonto verwendet werden sollen |
Returns | |
---|---|
RestApiHelper |
Ausgabe | |
---|---|
|
AllgemeineSicherheitsausnahme |
|
IOException |