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 di helper API con le informazioni fornite. |
|
Metodi pubblici | |
|---|---|
GenericUrl
|
buildQueryUri(String[] uriParts,
Costruisci un URI per una chiamata API con parti e opzioni URI specificate. |
HttpResponse
|
execute(String method, String[] uriParts,
Esegue una richiesta API. |
HttpRequestFactory
|
getRequestFactory()
Restituisce HttpRequestFactory. |
static
RestApiHelper
|
newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile,
Crea un'istanza di helper API che utilizza un |
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 di helper API con le informazioni fornite.
| Parametri | |
|---|---|
requestFactory |
HttpRequestFactory: la factory da utilizzare per creare HttpRequest. |
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 parti e opzioni URI specificate. uriParts deve essere già codificato in URL, mentre le opzioni devono essere stringhe non codificate.
| Parametri | |
|---|---|
uriParts |
String |
options |
|
| Ritorni | |
|---|---|
GenericUrl |
|
Esegui
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 dell'URI con codifica URL da utilizzare per creare l'URI della richiesta. |
options |
: nomi e valori dei parametri non codificati utilizzati per creare la stringa di query |
data |
JSONObject: dati da inviare con la richiesta |
| Ritorni | |
|---|---|
HttpResponse |
un oggetto HttpResponse |
getRequestFactory
public HttpRequestFactory getRequestFactory ()
Restituisce HttpRequestFactory.
Esposto per i test.
| Ritorni | |
|---|---|
HttpRequestFactory |
|
newInstanceWithGoogleCredential
public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, File jsonKeyFile,scopes)
Crea un'istanza di helper API che utilizza un Credential per l'autenticazione.
| Parametri | |
|---|---|
baseUri |
String: l'URI di base dell'API |
jsonKeyFile |
File: il file della chiave JSON dell'account di servizio |
scopes |
: la raccolta di ambiti OAuth da utilizzare con l'account di servizio |
| Ritorni | |
|---|---|
RestApiHelper |
|
| Lanci | |
|---|---|
|
GeneralSecurityException |
|
IOException |