RestApiHelper
public
class
RestApiHelper
extends Object
implements
IRestApiHelper
| java.lang.Object | |
| ↳ | com.android.tradefed.util.RestApiHelper |
Una classe helper per eseguire chiamate API REST.
Riepilogo
Costanti | |
|---|---|
int |
DEFAULT_NUMBER_OF_RETRIES
|
String |
JSON_MIME
|
Campi | |
|---|---|
protected
static
final
JsonFactory |
JSON_FACTORY
|
Costruttori pubblici | |
|---|---|
RestApiHelper(HttpRequestFactory requestFactory, String baseUri)
Crea un'istanza helper API con le informazioni fornite. |
|
Metodi pubblici | |
|---|---|
GenericUrl
|
buildQueryUri(String[] uriParts, Map<String, Object> options)
Costruisci un URI per una chiamata API con le parti e le opzioni dell'URI specificate. |
HttpResponse
|
execute(String method, String[] uriParts, Map<String, Object> options, JSONObject data)
Esegue una richiesta API. |
HttpRequestFactory
|
getRequestFactory()
Restituisce HttpRequestFactory. |
static
RestApiHelper
|
newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, Collection<String> scopes)
Crea un'istanza helper API che utilizza un |
Costanti
DEFAULT_NUMBER_OF_RETRIES
protected static final int DEFAULT_NUMBER_OF_RETRIES
Valore costante: 2 (0x00000002)
JSON_MIME
protected static final String JSON_MIME
Valore costante: "application/json"
Campi
JSON_FACTORY
protected static final JsonFactory JSON_FACTORY
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 per la creazione di HttpRequest. |
baseUri |
String: l'URI di base dell'API |
Metodi pubblici
buildQueryUri
public GenericUrl buildQueryUri (String[] uriParts,
Map<String, Object> options)Crea un URI per una chiamata API con le parti e le opzioni dell'URI specificate. uriParts deve essere già codificato nell'URL, mentre le opzioni devono essere stringhe non codificate.
| Parametri | |
|---|---|
uriParts |
String |
options |
Map |
| Resi | |
|---|---|
GenericUrl |
|
execute
public HttpResponse execute (String method,
String[] uriParts,
Map<String, Object> options,
JSONObject data)Esegue una richiesta API.
| Parametri | |
|---|---|
method |
String: un metodo HTTP della richiesta |
uriParts |
String: parti dell'URI codificate in URL da utilizzare per costruire l'URI della richiesta. |
options |
Map: nomi e valori dei parametri non codificati utilizzati per creare la stringa di query |
data |
JSONObject: dati da inviare con la richiesta |
| Resi | |
|---|---|
HttpResponse |
un oggetto HttpResponse |
| Genera | |
|---|---|
IOException |
|
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Restituisce HttpRequestFactory.
Esposto per i test.
| Resi | |
|---|---|
HttpRequestFactory |
|
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile, Collection<String> scopes)
Crea un'istanza helper API che utilizza un Credential per l'autenticazione.
| Parametri | |
|---|---|
baseUri |
String: l'URI di base dell'API |
jsonKeyFile |
File: il file JSON con le chiavi dell'account di servizio |
scopes |
Collection: la raccolta di ambiti OAuth da utilizzare con il service account |
| Resi | |
|---|---|
RestApiHelper |
|
| Genera | |
|---|---|
|
java.io.IOException |
|
java.security.GeneralSecurityException |
GeneralSecurityException |
|
IOException |
|