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 Konstrukteure | |
---|---|
RestApiHelper (HttpRequestFactory requestFactory, String baseUri) Erstellt eine API-Hilfsinstanz mit den angegebenen Informationen. |
Öffentliche Methoden | |
---|---|
GenericUrl | buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options) Konstruieren Sie einen URI für einen API-Aufruf mit gegebenen URI-Teilen und -Optionen. |
HttpResponse | execute (String method, String[] uriParts, options, JSONObject data) execute (String method, String[] uriParts, options, JSONObject data) Führt eine API-Anfrage aus. |
HttpRequestFactory | getRequestFactory () Gibt die HttpRequestFactory zurück. |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes) Erzeugt eine API helper Instanz , die eine verwendet |
static RestApiHelper | newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes) Erzeugt eine API helper Instanz , die eine verwendet |
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 Konstrukteure
RestApiHelper
public RestApiHelper (HttpRequestFactory requestFactory, String baseUri)
Erstellt eine API-Hilfsinstanz mit den angegebenen Informationen.
Parameter | |
---|---|
requestFactory | HttpRequestFactory : die Fabrik Verwendung bei der Erstellung von HttpRequest s. |
baseUri | String : die Basis - URI API |
Öffentliche Methoden
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,options)
Konstruieren Sie einen URI für einen API-Aufruf mit gegebenen URI-Teilen und -Optionen. uriParts sollten bereits URL-kodiert sein, während Optionen unkodierte Strings sein sollten.
Parameter | |
---|---|
uriParts | String |
options |
Kehrt zurück | |
---|---|
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 Anforderung |
uriParts | String : URL codierte URI Teile verwendet werden , um die Anforderungs - URI zu konstruieren. |
options | |
data | JSONObject : Daten werden mit der Anfrage gesendet |
Kehrt zurück | |
---|---|
HttpResponse | ein HttpResponse-Objekt |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Gibt die HttpRequestFactory zurück.
Zum Testen ausgesetzt.
Kehrt zurück | |
---|---|
HttpRequestFactory |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Erzeugt eine API helper Instanz , die eine verwendet Credential
zur Authentifizierung.
Parameter | |
---|---|
baseUri | String : die Basis - URI des API |
jsonKeyFile | File : das Dienstkonto json Schlüsseldatei |
scopes |
Kehrt zurück | |
---|---|
RestApiHelper |
Würfe | |
---|---|
| AllgemeineSicherheitsausnahme |
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile,scopes)
Erzeugt eine API helper Instanz , die eine verwendet Credential
zur Authentifizierung.
Parameter | |
---|---|
baseUri | String : die Basis - URI des API |
serviceAccount | String : der Name des Dienstkonto verwenden |
keyFile | File : das Dienstkonto Schlüsseldatei |
scopes |
Kehrt zurück | |
---|---|
RestApiHelper |
Würfe | |
---|---|
| AllgemeineSicherheitsausnahme |