RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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


Una classe di supporto per l'esecuzione di chiamate API REST.

Riepilogo

costanti

int DEFAULT_NUMBER_OF_RETRIES

Campi

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Costruttori pubblici

RestApiHelper (HttpRequestFactory requestFactory, String baseUri)

Crea un'istanza dell'helper API con le informazioni fornite.

Metodi pubblici

GenericUrl buildQueryUri (String[] uriParts, options) buildQueryUri (String[] uriParts, options)

Costruisci un URI per una chiamata API con determinate parti e opzioni URI.

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

Esegue una richiesta API.

HttpRequestFactory getRequestFactory ()

Restituisce HttpRequestFactory.

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

Crea un'istanza helper API che utilizza un Credential di autenticazione.

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

Crea un'istanza helper API che utilizza un Credential di autenticazione.

costanti

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valore costante: 2 (0x00000002)

Campi

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Costruttori pubblici

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Crea un'istanza dell'helper API con le informazioni fornite.

Parametri
requestFactory HttpRequestFactory : la fabbrica da utilizzare per creare HttpRequest s.

baseUri String : la base URI di API

Metodi pubblici

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Costruisci un URI per una chiamata API con determinate parti e opzioni URI. uriParts dovrebbe essere già codificato come URL, mentre le opzioni dovrebbero essere stringhe non codificate.

Parametri
uriParts String

options

ritorna
GenericUrl

eseguire

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

Esegue una richiesta API.

Parametri
method String : un metodo HTTP della richiesta

uriParts String : URL codificato parti URI da utilizzare per costruire la richiesta URI.

options : nomi di parametri e valori non codificati utilizzati per costruire la stringa di query

data JSONObject : dati da inviare con la richiesta

ritorna
HttpResponse un oggetto HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Restituisce HttpRequestFactory.

Esposto per test.

ritorna
HttpRequestFactory

newInstanceWithGoogleCredential

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

Crea un'istanza helper API che utilizza un Credential di autenticazione.

Parametri
baseUri String : la base URI della API

jsonKeyFile File : il file di chiave JSON account di servizio

scopes : la raccolta di ambiti OAuth da utilizzare con l'account di servizio

ritorna
RestApiHelper

tiri
GeneralSecurityException

newInstanceWithGoogleCredential

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

Crea un'istanza helper API che utilizza un Credential di autenticazione.

Parametri
baseUri String : la base URI della API

serviceAccount String : il nome del servizio account da utilizzare

keyFile File : il file di chiave di account di servizio

scopes : la raccolta di ambiti OAuth da utilizzare con l'account di servizio

ritorna
RestApiHelper

tiri
GeneralSecurityException