Ab dem 27. März 2025 empfehlen wir, android-latest-release anstelle von aosp-main zu verwenden, um AOSP zu erstellen und Beiträge dazu zu leisten. Weitere Informationen finden Sie unter Änderungen am AOSP.

Diese Seite wurde von der Cloud Translation API übersetzt.

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-Hilfsprogramminstanz mit den angegebenen Informationen.

Öffentliche Methoden
`GenericUrl`	`buildQueryUri(String[] uriParts, options)` Erstellt einen URI für einen API-Aufruf mit den angegebenen URI-Teilen und Optionen.
`HttpResponse`	`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)` Erstellt eine API-Helferinstanz, die ein `Credential` für die Authentifizierung verwendet.

Konstanten

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Konstanter Wert: 2 (0x00000002)

JSON_MIME

protected static final String JSON_MIME

Konstanter Wert: "application/json"

Felder

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

Öffentliche Konstruktoren

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Erstellt eine API-Hilfsprogramminstanz mit den angegebenen Informationen.

Parameter
`requestFactory`	`HttpRequestFactory`: die Fabrik, die beim Erstellen von `HttpRequest`s verwendet werden soll.
`baseUri`	`String`: Der Basis-URI der API.

Öffentliche Methoden

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Erstellt einen URI für einen API-Aufruf mit den angegebenen URI-Teilen und Optionen. „uriParts“ sollten bereits URL-codiert sein, während „options“ uncodierte 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 sollen

Returns
`HttpResponse`	ein HttpResponse-Objekt

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Gibt die HttpRequestFactory zurück.

Für Tests verfügbar gemacht.

Returns
`HttpRequestFactory`

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 scopes)

Erstellt eine API-Helferinstanz, die ein 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
	GeneralSecurityException
	IOException