À partir du 27 mars 2025, nous vous recommandons d'utiliser android-latest-release au lieu de aosp-main pour créer et contribuer à AOSP. Pour en savoir plus, consultez la section Modifications apportées à AOSP.

Cette page a été traduite par l'API Cloud Translation.

RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

java.lang.Object
↳	com.android.tradefed.util.RestApiHelper

Classe d'assistance pour effectuer des appels d'API REST.

Résumé

Constantes
`int`	`DEFAULT_NUMBER_OF_RETRIES`
`String`	`JSON_MIME`

Champs
`protected static final JsonFactory`	`JSON_FACTORY`

Constructeurs publics
`RestApiHelper(HttpRequestFactory requestFactory, String baseUri)` Crée une instance d'assistance pour l'API avec les informations fournies.

Méthodes publiques
`GenericUrl`	`buildQueryUri(String[] uriParts, options)` Construisez un URI pour un appel d'API avec les parties et les options d'URI données.
`HttpResponse`	`execute(String method, String[] uriParts, options, JSONObject data)` Exécute une requête API.
`HttpRequestFactory`	`getRequestFactory()` Renvoie HttpRequestFactory.
`static RestApiHelper`	`newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, scopes)` Crée une instance d'assistant d'API qui utilise un `Credential` pour l'authentification.

Constantes

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valeur constante : 2 (0x00000002)

JSON_MIME

protected static final String JSON_MIME

Valeur de constante : "application/json"

Champs

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

Constructeurs publics

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Crée une instance d'assistance pour l'API avec les informations fournies.

Paramètres
`requestFactory`	`HttpRequestFactory` : fabrique à utiliser lors de la création de `HttpRequest`.
`baseUri`	`String` : URI de base de l'API

Méthodes publiques

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Construit un URI pour un appel d'API avec les parties et les options d'URI données. uriParts doit déjà être encodé au format URL, tandis que les options doivent être des chaînes non encodées.

Paramètres
`uriParts`	`String`
`options`

Renvoie
`GenericUrl`

exécuter

public HttpResponse execute (String method, 
                String[] uriParts, 
                 options, 
                JSONObject data)

Exécute une requête API.

Paramètres
`method`	`String` : méthode HTTP de la requête
`uriParts`	`String` : parties de l'URI encodées en URL à utiliser pour construire l'URI de la requête.
`options`	: noms et valeurs des paramètres non encodés utilisés pour construire la chaîne de requête
`data`	`JSONObject` : données à envoyer avec la requête

Renvoie
`HttpResponse`	un objet HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Renvoie HttpRequestFactory.

Exposé pour les tests.

Renvoie
`HttpRequestFactory`

newInstanceWithGoogleCredential

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

Crée une instance d'assistant d'API qui utilise un Credential pour l'authentification.

Paramètres
`baseUri`	`String` : URI de base de l'API
`jsonKeyFile`	`File` : fichier de clé JSON du compte de service
`scopes`	: ensemble des niveaux d'accès OAuth à utiliser avec le compte de service

Renvoie
`RestApiHelper`

Génère
	GeneralSecurityException
	IOException