Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper en implements IRestApiHelper

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


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

Sommaire

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)

Construisez un URI pour un appel d'API avec des parties et des options d'URI 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 le HttpRequestFactory.

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

Crée une instance d'aide de l' API qui utilise une Credential d' 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'aide de l' API qui utilise une Credential d' 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 : l'usine à utiliser lors de la création HttpRequest s.

baseUri String : l'URI de base de l' API

Méthodes publiques

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Construisez un URI pour un appel d'API avec des parties et des options d'URI données. Les uriParts doivent déjà être codées en URL, tandis que les options doivent être des chaînes non codé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 : un procédé HTTP de la demande

uriParts String : URL encodée parties URI à 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 à la demande

Retour
HttpResponse un objet HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Renvoie HttpRequestFactory.

Exposé pour les tests.

Retour
HttpRequestFactory

newInstanceWithGoogleCredential

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

Crée une instance d'aide de l' API qui utilise une Credential d' Credential pour l' authentification.

Paramètres
baseUri String : l'URI de base de l'API

jsonKeyFile File : le compte de service fichier clé JSON

scopes : la collection de champs d'application OAuth à utiliser avec le compte de service

Retour
RestApiHelper

Jetés
Exception de sécurité générale

newInstanceWithGoogleCredential

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

Crée une instance d'aide de l' API qui utilise une Credential d' Credential pour l' authentification.

Paramètres
baseUri String : l'URI de base de l'API

serviceAccount String : le nom du service compte à utiliser

keyFile File : le compte de service fichier clé

scopes : la collection de champs d'application OAuth à utiliser avec le compte de service

Retour
RestApiHelper

Jetés
Exception de sécurité générale