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

Une classe d'assistance pour effectuer des appels d'API REST.

Résumé

Constantes
`int`	`DEFAULT_NUMBER_OF_RETRIES`

Des champs
`protected static final JsonFactory`	`JSON_FACTORY`
`protected static final String`	`JSON_MIME`

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

Méthodes publiques
`GenericUrl`	`buildQueryUri (String[] uriParts, options)` `buildQueryUri (String[] uriParts, options)` Construire un URI pour un appel d'API avec des parties d'URI et des options données.
`HttpResponse`	`execute (String method, String[] uriParts, options, JSONObject data)` `execute (String method, String[] uriParts, options, JSONObject data)` Exécute une requête API.
`HttpRequestFactory`	`getRequestFactory ()` Renvoie la HttpRequestFactory.
`static RestApiHelper`	`newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes)` `newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, scopes)` Crée une instance d'assistance d'API qui utilise un `Credential` pour l'authentification.
`static RestApiHelper`	`newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)` `newInstanceWithGoogleCredential (String baseUri, String serviceAccount, File keyFile, scopes)` Crée une instance d'assistance 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)

Des champs

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Constructeurs publics

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

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

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

Méthodes publiques

buildQueryUribuildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

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

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

Retour
`GenericUrl`

exécuter

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

Exécute une requête API.

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

Retour
`HttpResponse`	un objet HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Renvoie la HttpRequestFactory.

Exposé pour essai.

Retour
`HttpRequestFactory`

newInstanceWithGoogleCredential

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

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

Paramètres
`baseUri`	`String` : l'URI de base de l'API
`jsonKeyFile`	`File` : le fichier de clé JSON du compte de service
`scopes`	: la collection de champs d'application OAuth à utiliser avec le compte de service

Retour
`RestApiHelper`

Lance
	GeneralSecurityException
	IOException

newInstanceWithGoogleCredential

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                String serviceAccount, 
                File keyFile, 
                 scopes)

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

Paramètres
`baseUri`	`String` : l'URI de base de l'API
`serviceAccount`	`String` : le nom du compte de service à utiliser
`keyFile`	`File` : le fichier clé du compte de service
`scopes`	: la collection de champs d'application OAuth à utiliser avec le compte de service

Retour
`RestApiHelper`

Lance
	GeneralSecurityException
	IOException