RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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

Una clase auxiliar para realizar llamadas a la API 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 auxiliar de API con la información proporcionada.

Métodos públicos

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

Construya un URI para una llamada API con partes y opciones de URI determinadas.

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

Ejecuta una solicitud API.

HttpRequestFactory getRequestFactory ()

Devuelve HttpRequestFactory.

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

Crea una instancia auxiliar de API que utiliza una Credential para la autenticación.

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

Crea una instancia auxiliar de API que utiliza una 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 auxiliar de API con la información proporcionada.

Parámetros
requestFactory HttpRequestFactory : la fábrica que se utilizará al crear HttpRequest s.

baseUri String : el URI base de la API

Métodos públicos

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

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

Parámetros
uriParts String

options

Devoluciones
GenericUrl

ejecutar

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

Ejecuta una solicitud API.

Parámetros
method String : un método HTTP de la solicitud

uriParts String : partes de URI codificadas en URL que se utilizarán para construir el URI de solicitud.

options : nombres de parámetros y valores no codificados utilizados para construir la cadena de consulta

data JSONObject : datos que se enviarán con la solicitud

Devoluciones
HttpResponse un objeto HttpResponse

obtener fábrica de solicitudes

public HttpRequestFactory getRequestFactory ()

Devuelve HttpRequestFactory.

Expuesto para pruebas.

Devoluciones
HttpRequestFactory

nuevaInstanciaConGoogleCredential

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

Crea una instancia auxiliar de API que utiliza una Credential para la autenticación.

Parámetros
baseUri String : el URI base de la API

jsonKeyFile File : el archivo de clave json de la cuenta de servicio

scopes : la colección de ámbitos de OAuth para usar con la cuenta de servicio

Devoluciones
RestApiHelper

Lanza
Excepción de seguridad general
IOExcepción

nuevaInstanciaConGoogleCredential

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

Crea una instancia auxiliar de API que utiliza una Credential para la autenticación.

Parámetros
baseUri String : el URI base de la API

serviceAccount String : el nombre de la cuenta de servicio que se utilizará

keyFile File : el archivo de clave de la cuenta de servicio

scopes : la colección de ámbitos de OAuth para usar con la cuenta de servicio

Devoluciones
RestApiHelper

Lanza
Excepción de seguridad general
IOExcepción