RestApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

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


Uma classe auxiliar para realizar chamadas da API REST.

Resumo

Constantes

int DEFAULT_NUMBER_OF_RETRIES

Campos

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

Construtores públicos

RestApiHelper(HttpRequestFactory requestFactory, String baseUri)

Cria uma instância de assistente de API com as informações fornecidas.

Métodos públicos

GenericUrl buildQueryUri(String[] uriParts, options)

Construir um URI para uma chamada de API com determinadas partes e opções de URI.

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

Executa uma solicitação de API.

HttpRequestFactory getRequestFactory()

Retorna a HttpRequestFactory.

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

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

Constantes

NÚMERO_PADRÃO_NÚMERO_DE_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

Construtores públicos

RestApiHelper

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

Cria uma instância de assistente de 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, 
                 options)

Construir um URI para uma chamada de API com determinadas partes e opções de URI. uriParts deverá ser O URL já está codificado, mas as opções precisam ser strings não codificadas.

Parâmetros
uriParts String

options

Retorna
GenericUrl

executar

public HttpResponse execute (String method, 
                String[] uriParts, 
                 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 pelo URL a serem usadas para construir o URI da solicitação.

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

data JSONObject: dados que serão enviados com a solicitação.

Retorna
HttpResponse um objeto HttpResponse

getRequestFactory

public HttpRequestFactory getRequestFactory ()

Retorna a HttpRequestFactory.

Exposto para teste.

Retorna
HttpRequestFactory

newInstanceWithGoogleCredential

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

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

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

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

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

Retorna
RestApiHelper

Gera
Exceção geral de segurança
IOException