AideRAPI

public class RestApiHelper
extends Object implements IRestApiHelper

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

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

Résumé

Constantes

int DEFAULT_NUMBER_OF_RETRIES

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)

Créez un URI pour un appel d'API à l'aide des parties et des options d'URI indiquées.

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

Exécute une requête API.

HttpRequestFactory getRequestFactory()

Renvoie la classe HttpRequestFactory.

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, 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)

Champs

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Constructeurs publics

AideRAPI

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Crée une instance d'assistance d'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

URI de requête de compilation

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Créez un URI pour un appel d'API à l'aide des parties et des options d'URI indiquées. uriParts doit être Les URL sont déjà encodées, tandis que les options ne doivent pas être des chaînes.

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 au format URL à utiliser pour créer 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 la classe HttpRequestFactory.

Exposée à des fins de test.

Renvoie
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: URI de base de l'API.
jsonKeyFile File: fichier de clé JSON du compte de service
scopes : collection des champs d'application OAuth à utiliser avec le compte de service
Renvoie
RestApiHelper

Génère
GeneralSecurityException
IOException