RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

Es una clase auxiliar para realizar llamadas a la API de REST.

Resumen

Constantes

int DEFAULT_NUMBER_OF_RETRIES

Campos

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Constructores públicos

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Crea una instancia de ayuda de la API con la información proporcionada.

Métodos públicos

GenericUrl buildQueryUri(String[] uriParts, options)

Crea un URI para una llamada a la API con partes y opciones de URI determinadas.

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

Ejecuta una solicitud a la API.

HttpRequestFactory getRequestFactory()

Devuelve HttpRequestFactory.

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

Crea una instancia de ayuda de la API que usa un Credential para la autenticación.

Constantes

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valor constante: 2 (0x00000002)

Campos

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

JSON_MIME

protected static final String JSON_MIME

Constructores públicos

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Crea una instancia de ayuda de la API con la información proporcionada.

Parámetros
requestFactory HttpRequestFactory: Es la fábrica que se usará cuando se creen HttpRequest.
baseUri String: Es el URI base de la API.

Métodos públicos

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

Crea un URI para una llamada a la API con partes y opciones de URI determinadas. uriParts ya debería estar codificado como URL, mientras que las opciones deberían ser cadenas sin codificar.

Parámetros
uriParts String

options

Muestra
GenericUrl

ejecutar

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

Ejecuta una solicitud a la API.

Parámetros
method String: Es un método HTTP de la solicitud.
uriParts String: Son partes de URI con codificación de URL que se usarán para construir el URI de solicitud.
options : Son los nombres y valores de los parámetros sin codificar que se usan para construir la cadena de consulta.
data JSONObject: Son los datos que se enviarán con la solicitud.
Muestra
HttpResponse un objeto HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Devuelve HttpRequestFactory.

Se expone para pruebas.

Muestra
HttpRequestFactory

newInstanceWithGoogleCredential

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

Crea una instancia de ayuda de la API que usa un Credential para la autenticación.

Parámetros
baseUri String: Es el URI base de la API.
jsonKeyFile File: Es el archivo de clave JSON de la cuenta de servicio.
scopes : Es la colección de permisos de OAuth que se usarán con la cuenta de servicio.
Muestra
RestApiHelper

Arroja
GeneralSecurityException
IOException