RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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


Uma classe auxiliar para realizar chamadas de API REST.

Resumo

Constantes

int DEFAULT_NUMBER_OF_RETRIES

String JSON_MIME

Campos

protected static final JsonFactory JSON_FACTORY

Construtores públicos

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Cria uma instância auxiliar da API com as informações fornecidas.

Métodos públicos

GenericUrl buildQueryUri(String[] uriParts, Map<String, Object> options)

Cria um URI para uma chamada de API com as partes e opções de URI fornecidas.

HttpResponse execute(String method, String[] uriParts, Map<String, Object> options, JSONObject data)

Executa uma solicitação de API.

HttpRequestFactory getRequestFactory()

Retorna o HttpRequestFactory.

static RestApiHelper newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, Collection<String> scopes)

Cria uma instância auxiliar da API que usa um Credential para autenticação.

Constantes

DEFAULT_NUMBER_OF_RETRIES

protected static final int DEFAULT_NUMBER_OF_RETRIES

Valor da constante: 2 (0x00000002)

JSON_MIME

protected static final String JSON_MIME

Valor da constante: "application/json"

Campos

JSON_FACTORY

protected static final JsonFactory JSON_FACTORY

Construtores públicos

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Cria uma instância auxiliar da API com as informações fornecidas.

Parâmetros
requestFactory HttpRequestFactory: a fábrica a ser usada ao criar HttpRequests.

baseUri String: o URI base da API.

Métodos públicos

buildQueryUri

public GenericUrl buildQueryUri (String[] uriParts, 
                Map<String, Object> options)

Crie um URI para uma chamada de API com as partes e opções de URI fornecidas. uriParts já precisa estar codificado por URL, enquanto options precisa ser uma string não codificada.

Parâmetros
uriParts String

options Map

Retorna
GenericUrl

execute

public HttpResponse execute (String method, 
                String[] uriParts, 
                Map<String, Object> options, 
                JSONObject data)

Executa uma solicitação de API.

Parâmetros
method String: um método HTTP da solicitação

uriParts String: partes do URI codificadas por URL a serem usadas para construir o URI de solicitação.

options Map: nomes e valores de parâmetros não codificados usados para construir a string de consulta.

data JSONObject: dados a serem enviados com a solicitação

Retorna
HttpResponse um objeto HttpResponse

Gera
IOException

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Retorna o HttpRequestFactory.

Exposto para testes.

Retorna
HttpRequestFactory

newInstanceWithGoogleCredential

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

Cria uma instância auxiliar da API que usa um Credential para autenticação.

Parâmetros
baseUri String: o URI de base da API.

jsonKeyFile File: o arquivo de chave json da conta de serviço

scopes Collection: a coleção de escopos do OAuth a serem usados com a conta de serviço.

Retorna
RestApiHelper

Gera
java.io.IOException
java.security.GeneralSecurityException
GeneralSecurityException
IOException