RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

Una classe helper 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 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 dell'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 una Credential per l'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 una Credential per l'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 helper API con le informazioni fornite.

Parametri
requestFactory HttpRequestFactory : la factory da utilizzare durante la creazione HttpRequest s.

baseUri String : l'URI di base dell'API

Metodi pubblici

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Costruisci un URI per una chiamata API con determinate parti e opzioni dell'URI. uriParts dovrebbe essere già codificato nell'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 : parti URI con codifica URL da utilizzare per costruire l'URI della richiesta.

options : nomi e valori dei parametri 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 il test.

ritorna
HttpRequestFactory

newInstanceWithGoogleCredential

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

Crea un'istanza helper API che utilizza una Credential per l'autenticazione.

Parametri
baseUri String : l'URI di base dell'API

jsonKeyFile File : il file chiave json dell'account di servizio

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

ritorna
RestApiHelper

Getta
GeneraleSecurityException
IOException

newInstanceWithGoogleCredential

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

Crea un'istanza helper API che utilizza una Credential per l'autenticazione.

Parametri
baseUri String : l'URI di base dell'API

serviceAccount String : il nome dell'account di servizio da utilizzare

keyFile File : il file della chiave dell'account di servizio

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

ritorna
RestApiHelper

Getta
GeneraleSecurityException
IOException